Node.js APP https://radiant-beach-46005.herokuapp.com/
Put your all config varibale related to db etc here
./config/appConfig.jsnpm install
npm start
http://localhost:3000POST http://localhost:3000/api/v1/register
POST http://localhost:3000/api/v1/login
POST http://localhost:3000/api/v1/planets
GET http://localhost:3000/api/v1/planets/
GET http://localhost:3000/api/v1/planets/?limit=2&offset=1
GET http://localhost:3000/api/v1/planets/1
PUT http://localhost:3000/api/v1/planets/1
DEL http://localhost:3000/api/v1/planets/1
POST http://localhost:3000/api/v1/comments
GET http://localhost:3000/api/v1/comments
GET http://localhost:3000/api/v1/comments?planet=1
GET http://localhost:3000/api/v1/comments?limit=2&offset=1
{
"username": "testtask",
"secret": "2222"
}
{
"id": 2,
"name": "Alderaan",
"rotation_period": "24",
"orbital_period": "364",
"diameter": "12500",
"climate": "temperate",
"gravity": "1 standard",
"terrain": "grasslands, mountains",
"surface_water": "40",
"population": "2000000000",
"residents": [
"https://swapi.co/api/people/5/",
"https://swapi.co/api/people/68/"
],
"films": [
"https://swapi.co/api/films/6/",
"https://swapi.co/api/films/1/"
],
"url": "https://swapi.co/api/planets/2/",
"updatedAt": "2018-03-14T22:38:56.779Z",
"createdAt": "2018-03-14T22:38:56.779Z",
"comment": null
}
{
"id": "1",
"comment": "This is my comment added in 1"
}
This project is built using node.js with express.js framework, postgres database using sequelize and third party api integration (SWAPI).
It is simple rest api app that use json web token and SWAPI (The Star Wars API). Once register then login and get token.
and later all requests use jwt token http header(x-access-token) for sending authenticated requested.
SPECIFICATION
REST API with postgres database and usage of external JSON API with simple json web token authentication. Full specification of routes below:
POST /register:
Request body should containing planet's username and secret in request body.
Response will return HTTP 201 with empty body.
POST /login:
Request body should containing planet's username and secret in request body.
Response will return HTTP 200 with the fetched token as response's body.
Now below Only authorized request should be allowed, not-authorized requests should receive proper HTTP error.
POST /planets:
Request body should containing planet's name,
Request data will be validated and accept only name as a string,
Additional data will be fetched from https://swapi.co/, aginst provided planet name and saved to database,
response will return HTTP 201 with the fetched data as response's body.
GET /planets:
List all planets from database,
Pagination, filtering and sorting on id basis is added!
GET /planets/:id
It will return a planet by id from database,
POST /comments:
Request will contains comment's text and planet's ID,
it will add a comment to a given planet and return that comment as response body.
GET /comments:
it will fetch list of all comments from database and allow for filtering, pagination by planet using /comments?planet=:planet_id&limit=1&offset=1 query parameter.
DELETE /planets/:id
It will remove a given planet from database.
PUT /planets/:id
It will update a given planet by id in database.
Backend use node.js with express.js framework. Routing has functionality for changing route quickly with with quick option to change api version
|-- ./
├── app.js
├── bin
| └── www
├── config
| └── appConfig.js
├── controller
| ├── authenticationController.js
| ├── commentController.js
| └── planetController.js
├── models
| ├── index.js
| ├── planet.js
| └── user.js
├── out.txt
├── package.json
├── pm2.json
├── Readme.md
├── routes
| ├── index.js
| └── v1
| ├── authentication.js
| ├── comment.js
| └── planet.js
└── service
├── authenticationService.js
├── commentService.js
├── planetService.js
└── tokenService.js
This application uses Async/Await. In order to use it as intended, you need atleast Node v7.6.
$ docker-compose up --buildPostman collection is added for testing in local system and heroku