This is the first app with RESTful-API
npm init
express --save=ejs
npm install --save sequelize
npm install --save sequelize-cli
sequelize init
npm install --save jsonwebtoken
npm install dotenv --save
psql postgres
postgres# CREATE DATABASE "rest_api";
Resource How to markdown
Setting Database on Sequelize
Create Model User
sequelize model:create --name User --attributes username:string,password:string
Database Migration (to create table on database)
sequelize db:migrate
| routes | HTTP | Description |
|---|---|---|
| /api/signup | POST | Sign up with new user info |
| /api/signin | POST | Sign in while get an access token based on credentials |
| /api/users | GET | Get all the users info (admin only) |
| /api/users/:id | GET | Get a single user info (admin and authenticated user) |
| /api/users | POST | Create a user (admin only) |
| /api/users/:id | DELETE | Delete a user (admin only) |
| /api/users/:id | PUT | Update a user with new info (admin and authenticated user) |
1st Step
npm start
using postman go to url : (POST) http://localhost:3000/api/signup
fill on x-www-form-urlencoded
key & value
username : your username (e.g : pdvega)
password : your password (e.g : pdvega)
role : your role (e.g admin or user or other)
Congratulation, you've got new user account!
2nd Step
You can sign in now.
Using postman go to url : (POST) http://localhost:3000/api/signin
fill on x-www-form-urlencoded
key & value
username : your username (e.g : pdvega)
password : your password (e.g : pdvega)
Got the token.
3rd Step
Using postman go to url : (GET) http://localhost:3000/api/users fill on Headers
key and value
token : your token when signin.
If your role as administrator, you can get all the data users.
If you are not, you will get notification that "You are not Administrator."
4th Step
Using postman go to url : (GET) http://localhost:3000/api/users/:id fill on Headers key and value
token : your token when signin.
As long as your role is not 'admin', you still can see your detail data user, with access http://localhost:3000/api/users/:your_id.
If you are not an Administrator, you will get notification that "You are not authorized to see other account."
If your role as administrator, you can see all the data users detail by their id.
5th Step
Using postman go to url : (POST) http://localhost:3000/api/users fill on Headers key and value
token : your token when signin.
For Administrator Only.
Create User on x-www-form-urlencoded with key and value:
username :
password :
role : user
6th Step
Using postman go to url : (PUT) http://localhost:3000/api/users/id fill on Headers key and value
token : your token when signin.
For Administrator Only.
Create User on x-www-form-urlencoded with key and value:
username :
password :
role :
7th Step
Using postman go to url : (DELETE) http://localhost:3000/api/users/id fill on Headers key and value
token : your token when signin.
For Administrator Only.
Deleted user with /:id.
.
├── README.md
├── rest-api
│ ├── bin
│ │ └── www
│ └── config
│ │ └── config.json
│ └── controllers
│ │ └── auth.js
│ │ └── users.js
│ └── helpers
│ │ └── auth.js
│ │ └── generateSalt.js
│ │ └── hash.js
│ └── migrations
│ │ └── 20170724040824-create-user.js
│ │ └── 20170724111610-addColumn_Secret_on_table_user.js
│ │ └── 20170724111852-addColumn_role_on_table_user.js
│ └── models
│ │ └── index.js
│ │ └── user.js
│ └── routes
│ │ └── auth.js
│ │ └── index.js
│ │ └── users.js
├── package.json
├── app.js
├── .env.template
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent