production-ready-calculator-api

This is a sample project of how to create a production ready serverless api with tests and continues integration process

Server Status

GitHub Repository

Installation

Install by running

npm install

Start the server with debug* (Optional to use F5 before running the script)

Start the server by running:

npm start

Start with nodemon by running:

npm run start-dev

Start the server with the netlify runner in dev mode (Debug is also optional here with F5)

Start the server by running:

npm run dev

Start the jest coverage tests

Start the tests by running:

npm test

API Design Documentation

/api/V0.1

POST

POST /api/V0.1/calculate

Query Parameters

• non

Body

• firstNumber - A number (large inputs are limited to exponent of 20, e+20)
• secondNumber - A number (large inputs are limited to exponent of 20, e+20)
• operator - A mathematical operator as string (+,-,*,/)

Response

• TEXT - Text contain the result of the calculation

Errors

• 404 - Not Found - With information about the uri and method used
• 500 - Internal Server Error - With text "Oops, something went wrong..."

For developers

• Error logs - The specific reasons for server errors (500) are detailed in informative logs that are not exposed by the api
• Rate Limit - The rate limit is set to the default values of Netlify (200/min)
• Access Control - Is set to Public without any authentication (It is possible to enable OAuth2 authentication in the Netlify server settings)

Example Request

request({
  method: 'POST',
  url: 'https://production-ready-calculator-api.netlify.app/api/V0.1/calculate',
  headers: {
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    firstNumber: 2,
    secondNumber: 6,
    operator: '+'
  },
});

Example Response

200 OK

8

Unit tests cover status

Pull Request / Contribute

PRs are only possible from a separate branch.

Before submitting a PR please validate lint, unit tests, test cover and version update:

• You should fix linting issues by running npm run fix-lint - Make sure to fix every error and warning.
• You should run unit tests by running npm test - Make sure that all the tests pass.
• The test coverage should remain at 100% : 100% Statements 76/76 | 100% Branches 18/18 | 100% Functions 9/9 | 100% Lines 71/71 - Make sure to add tests if needed.
• Always increment* the version, according to the specifications below.
• Adding a unit test that uncover a bug is very welcome - I will create a fix for the bug that will allow you to pull and merge your unit test ASAP.

*The correct way to increment the version is by using the correct npm script that represent the change you are introducing

Versions

Run npm version patch in cases of bug fixes or small modifications.

Run npm version minor in cases of functionality changes with non-breaking changes.

Run npm version major in cases of important functionality or any breaking changes.