Skip to content

Starting with Express.js enabled API server? Checkout this boilerplate made based on freecodecamp article on "REST API Design Best Practices Handbook" with minor revisions.

Notifications You must be signed in to change notification settings

Adrian-Fang/node-rest-api-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Node.js (Express) API Project Boilerplate

REST API made with a Router-Controller-Service(Data Access) 3 layer architecture, which I personally am not completely following, but trying to... 😺😺😺

Credit to

Credit to "REST API Design Best Practices Handbook", posted on freecodecamp, you may find the link below. https://www.freecodecamp.org/news/rest-api-design-best-practices-build-a-rest-api/

Since I couldn't find the author's github project link, I decided to create one, with:

  • some unfinished code realised
  • and swagger documentation code rewritten

What you would have on hand

  • Database "clean", feel free to add your favorite database managment tools
  • Filtering, Sorting, Pagination integrated (only for Workout.js)
  • Use data caching for performance improvements, with apicache, redisis an alternative
  • API documentation with Swagger
  • Integrated API access logging middleware with morgan
  • Some other practices might be too specified, not included.

Refs

About

Starting with Express.js enabled API server? Checkout this boilerplate made based on freecodecamp article on "REST API Design Best Practices Handbook" with minor revisions.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published