This is a proposal / example for creating restful APIs with node, express, sequelize and mysql.
- ES6 through babel
- node
- express
- sequelize
- mysql
blog-restful/
+-- .gitignore
+-- .babelrc
+-- .editorconfig
+-- package.json
+-- server.js
+-- app
¦ +-- controllers
¦ ¦ +-- user.ctrl.js
¦ ¦ +-- post.ctrl.js
¦ +-- models
¦ ¦ +-- index.js
¦ ¦ +-- user.js
¦ ¦ +-- post.js
¦ +-- routes
¦ ¦ +-- post.route.js
¦ ¦ +-- user.route.js
¦ +-- services
¦ ¦ +-- post.service.js
¦ ¦ +-- user.service.js
¦ +-- utils
¦ ¦ +-- common.util.js
¦ ¦ +-- logger.js
¦ +-- validators
¦ +-- post.validator.js
¦ +-- user.validator.js
+-- config
+-- express.js
+-- error.messages.js
+-- config.js
+-- env
¦ +-- all.js
¦ +-- development.js
¦ +-- production.js
¦ +-- test.js
+-- sslcerts
| # | api | description |
|---|---|---|
| 1 | get /api/users?limit=<#>&offset=<#>&status=active,inactive | Get all users based on input criteria such as status, limit.. |
| 2 | get /api/users/:userName | Get a user by userName |
| 3 | post /api/users/ | Create a new user |
| 4 | delete /api/users/:userName | Delete a user by userName |
| # | api | description |
|---|---|---|
| 1 | get /api/users/:userName/posts?limit=<#>&offset=<#>&status=active,inactive | Get all posts of a user based on input criteria such as status, limit.. |
| 2 | get /api/posts/:postId | Get a post by id |
| 3 | post /api/users/:userName/posts | Create a new post |
| 4 | delete /api/posts/:postId | Delete a post by post id |
| 5 | put /api/posts/:postId | Update a post by post id |
- start in development mode: npm run start:dev
- build the code to es5: npm run build
- run unit test: npm run test:unit