Theo2903/express-rest-api

A REST API with Express. Using Swagger for documentation and Docker to deploy

Express Rest API Swagger Base Project

A REST API with Express. Using Swagger for documentation and Docker to deploy

API Reference

Base URL

  GET /api/v1

Swagger URL

  GET /api-docs

Auth

Register

  POST /api/v1/register

Login

  POST /api/v1/login

Logout

  POST /api/v1/logout

User

Get all user

  GET /api/v1/user

Get user by ID

  GET /api/v1/user/:id

Parameter	Type	Description
id	string	Required. Id of item to fetch

Create user

  POST /api/v1/user

Update user by ID

  PUT /api/v1/user/:id

Parameter	Type	Description
id	string	Required. Id of item to fetch

Delete user by ID

  DELETE /api/v1/user/:id

Parameter	Type	Description
id	string	Required. Id of item to fetch

Installation

After cloning the project, make sure you have docker installed.

  docker-compose up --build
  http://localhost:3000/api-docs