Simple NodeJS API Server

In this example application, we use Swagger JSDoc and Swagger UI Express to automatically generate OpenAPI documentation. We create a simple NodeJS API server to demonstrate the power of autogenerated documentation.

Running the Server

With NodeJS installed, you can started the server by running,

node app.js

OR

npm run start

Accessing the Docs

With your local server running, the generated docs are available here: http://localhost:5000/api-docs

Development

This simple server can be easily extended. After cloning this repository you can start developing locally.

Locally (without Docker)

1. Install Nodemon, Nodemon will watch for file changes and restart the NodeJS process. This allows for faster development and testing.

npm install -g nodemon

2. With Nodemon installed, start the server using Nodemon

nodemon app.js

OR

npm run start:dev