przpiw / CRUD_API_swagger

Express CRUD app demonstrates integrate and document API with Swagger(Open API 3.0)

NodeJS CRUD API with swagger docs

This example is a good example for people who wants to start documenting Node.js API with Swagger.

Example covers requests documentation and documenting responses with schemas and example data

• GET
• POST
• PUT
• DELETE

How to use

Execute node index.js to run the example as an app

OR

Run in docker container

docker-compose -f docker-compose.yml pull && docker-compose -f docker-compose.yml up -d --build

---

Swagger Page - Navigate to http://localhost:4000/docs

Documentation in JSON format avaliable http://localhost:4000/docs.json

Example

How to import to Postman Downloaded JSON documentation can be imported to postman