The aim of this project is to have a simple and adaptable REST API Boilerplate.
This is a straightforward boilerplate application for building REST APIs in Node.js using Fastify with Code Coverage. Helps you stay productive by following best practices.
- Fastify: Fastify is a web framework highly focused on providing the best developer experience with the least overhead and a powerful plugin architecture. It is inspired by Hapi and Express and as far as we know, it is one of the fastest web frameworks in town.
- Winston: as a logger for the API.
- Newman: as a manager for the postman collections. It allows you to effortlessly run and test a Postman collection directly from the command-line.
- Sequelize: Sequelize is a promise-based Node.js ORM for Postgres, MySQL, MariaDB, SQLite and Microsoft SQL Server. It features solid transaction support, relations, eager and lazy loading, read replication and more.
- Jest + supertest: Powerfull combination to testing node.js HTTP servers.
- ESLint: a pluggable linter tool for identifying and reporting on patterns in JavaScript, combined with Prettier so with can get the benefits of
prettier'ssuperior formatting capabilities, but also benefit from the configuration capabilities ofeslint.javascript/tree/master/packages/eslint-config-airbnb), which tries to follow the Airbnb JavaScript style guide. | - npm: Uses npm as package manager.
- http-status: to set http status code. It is recommended to use
httpStatus.INTERNAL_SERVER_ERRORinstead of directly using500when setting status code.
- Install npm.
Clone the repo:
git clone [email protected]:vinistevam/fastify-rest-api.git
cd fastify-rest-apiInstall dependencies:
npm installStart server:
# Start server
node index.jsOpen your browser at http://localhost:3000
# Run tests
npm test
# Run test along with code coverage
npm run coverage
> [email protected] coverage /home/vstevam/Desktop/ConsenSys/API/fastify-rest-api
> jest --forceExit --detectOpenHandles --collectCoverage
PASS tests/routes/healthcheck.test.js
PASS tests/routes/root.test.js
-------------------|----------|----------|----------|----------|-------------------|
File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Line |
-------------------|----------|----------|----------|----------|-------------------|
All files | 100 | 100 | 100 | 100 | |
codefi-api | 100 | 100 | 100 | 100 | |
app.js | 100 | 100 | 100 | 100 | |
codefi-api/routes | 100 | 100 | 100 | 100 | |
healthcheck.js | 100 | 100 | 100 | 100 | |
-------------------|----------|----------|----------|----------|-------------------|
Test Suites: 2 passed, 2 total
Tests: 3 passed, 3 total
Snapshots: 0 total
Time: 1.044s
Ran all test suites.
npm run coverage also generates HTML code coverage report in coverage/ directory. Open lcov-report/index.html to view it.
# Run newman as a Node.js module (server needs to be running)
npm run newmanCurrent newman is configured to run through local collections but It supports run straight from URL.
/postman
├── collections # collections exported
│ ├── boilerplateRestAPI.json # collection
│ └── ... # Other collections
├── environment # local environment variable exported
│ ├── local.json # env
│ └── ... # Other env variable
newman
Boilerplate Rest API
❏ Healthcheck
↳ Healthcheck
GET http://127.0.0.1:3000/api/healthcheck [200 OK, 195B, 44ms]
→ root
GET http://127.0.0.1:3000/ [200 OK, 164B, 3ms]
┌─────────────────────────┬──────────────────┬──────────────────┐
│ │ executed │ failed │
├─────────────────────────┼──────────────────┼──────────────────┤
│ iterations │ 1 │ 0 │
├─────────────────────────┼──────────────────┼──────────────────┤
│ requests │ 2 │ 0 │
├─────────────────────────┼──────────────────┼──────────────────┤
│ test-scripts │ 2 │ 0 │
├─────────────────────────┼──────────────────┼──────────────────┤
│ prerequest-scripts │ 2 │ 0 │
├─────────────────────────┼──────────────────┼──────────────────┤
│ assertions │ 0 │ 0 │
├─────────────────────────┴──────────────────┴──────────────────┤
│ total run duration: 100ms │
├───────────────────────────────────────────────────────────────┤
│ total data received: 65B (approx) │
├───────────────────────────────────────────────────────────────┤
│ average response time: 23ms [min: 3ms, max: 44ms, s.d.: 20ms] │
└───────────────────────────────────────────────────────────────┘
# Lint the code
npm run lint
# Run Lint check
npm run eslint-check
# service restarts on file change
bash bin/development.sh# Build docker
docker build -t fastify-rest-api .
# Run docker
docker run -p 3000:3000 fastify-rest-apiStructure of a NodeJs API Project
.
├── config # App configuration files
│ ├── sequelize.json # Sequelize config
│ ├── serviceOne.js # ServiceOne config
│ └── ... # Other configurations
├── routes
│ ├── controllers # Request managers
│ ├── middlewares # Request middlewares
│ └── routes.js # Define routes and middlewares here
├── services # External services implementation
│ ├── serviceOne
│ └── serviceTwo
│ └── ... # Other services
├── db # Data access stuff (Sequelize mostly)
│ ├── models # Models
│ ├── migrations # Migrations
│ ├── seeds # Seeds
│ └── index.js # Sequelize instantiation
├── core # Business logic implementation
│ ├── accounts.js
│ ├── sales.js
│ ├── comments.js
│ └── ... # Other business logic implementations
├── utils # Util libs (formats, validation, etc)
├── tests # Testing
├── scripts # Standalone scripts for dev uses
├── package.json
├── README.md
├── index.js # Start script including `listen()`
└── app.js # App starting pointIf you would prefer not to use any of our tooling, delete the following files from the project: package.json and .eslintrc. You can now safely use the boilerplate with an alternative build-system or no build-system at all if you choose.
Contributions, questions and comments are all welcome and encouraged. For code contributions submit a pull request with appropriate test coverage.