Universities

Installation

Use the npm to install.

git clone https://github.com/jaxolv/universities.git
cd universities
npm install

Run

To run the application, it has to be created a file .env inside the folder universities. Using as example the file .env.example, inform the sensible data to connect with the database.

The database was created in MongoDB Atlas, so it has to be informed user, password, port and, most importantly, the key, wich is the link informed when you choose Connect > Connect your aplication after created a cluster.

Inform in the file .env the key as follow the example:

# PARAMS TO CONECTION - MONGODB
DB_PORT=8888
DB_KEY='mongodb+srv://<USERNAME>:<PASSWORD>@nameoftheapi.etc...'

DB_KEY: for <USERNAME> and <PASSWORD> has to be informed, respectively, the username and the password used in the creation of the database. The rest of the key has to be the same as copied originally.

DB_PORT: has to be informed the port used to run the application. In the example, 8888 it's the one that I used.

After that, it is possibly to save and run the API in the terminal using:

npm start

If Connected to MongoDB! appears in the terminal, it's everything okay to execute the API.

Documentation

The documentation to this API was made by Swagger. Make sure to run the API and then use the port informed for .env. As an example:

http://localhost:8888/universities/docs

If used another port than the one in this example, it is necessary to change it in the Swagger document. Go to ./src/docs/swagger.json and substitute the port in the line 11, column 38 to 42.

"url": "http://localhost:8888"

No other alteration will be necessary.

The same works for softwares like Insomnia or Postman to test the API.

Usage overview

POST /universities/populate

This request will populate the database with all the data from the 1020 universities.

This should be the message you receive when executed correctly:

{
  "message": "The database was succesfully populated!"
}

This request will not be executed again if the database have any information saved. So, be sure to use it at first.

POST /universities

This request will create an university.

Example:

{
    "domains": [
        "www.akad.de"
    ],
    "country": "Germany",
    "state-province": null,
    "web_pages": [
        "www.akad.de"
    ],
    "name": "AKAD Hochschulen f\u00fcr Berufst\u00e4tige",
    "alpha_two_code": "DE"
}

This request will not succeed if informed the exact same data from an university already existent in the database.

GET /universities

This request will return all the universities in the database.

It is possible to find the universities of a country informing as a query country one of those countries:

[
    "argentina", 
    "brazil", 
    "chile", 
    "colombia", 
    "paraguay", 
    "peru", 
    "suriname", 
    "uruguay"
]

GET /universities/:id

This request will return an unique university found by the ID informed.

The ID have to be informed as a param and will return all the data from the university.

PUT /universities/:id

This request will update some of the data from the university that will be found by the ID.

Example:

{
    "domains": [
        "akad.de"
    ],
    "web_pages": [
        "http://www.akad.de/"
    ],
    "name": "AKAD Hochschulen f\u00fcr Berufst\u00e4tige, Fachhochschule Leipzig"
}

The ID have to be informed as a param and will return only the body requested.

DELETE /universities/:id

This request will remove the university that will be found by the ID informed.

If executed correctly, the message University deleted succesfully. will be returned.

The ID have to be informed as a param.