docuisy_api v1.0.1

PoliciesApi

Pre-Requisites

• Install NodeJS
• Version - (at least).

Start API ✔

1. Install external packages.

• In the root folder, run the following command. - $ npm install.

2. Run server.

• In the root folder, run the following command. - $ npm start

3. PoliciesApi is ready!

Run Tests ⚙

1. Make sure that the API isn't running
2. In the root folder, run the following commands.
   • $ npm test.

Documentation 📄

All the API documentation was created with the standart OpenAPI.

SwaggerUI Documentation

1. Start API
2. Go to http://localhost:4000/api-docs

How I get a Token? 🔑

1. Use /authenticate service:
   • http://localhost:4000/api/auth/authenticate
   • Add Request body:

{
  "email": "evangelineblankenship@quotezart.com"
}

NOTE: I used only the email field to authenticate the user

Used Technologies/Tools

• NodeJS
• Express
• Express JSON Web Tokens
• Jest
• OpenAPI
• SwaggerUI
• ESLint + Prettier
• SuperTest