Skip to content
Example Node application with autogenerating Swagger Documentation
JavaScript
Branch: master
Clone or download
Brian Childress
Brian Childress Initial Commit
Latest commit dc10603 Sep 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets Initial Commit Sep 23, 2019
.gitignore Initial Commit Sep 23, 2019
README.md Initial Commit Sep 23, 2019
app.js Initial Commit Sep 23, 2019
package.json Initial Commit Sep 23, 2019

README.md

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.

Tutorial Available

YouTube: Autogenerating Swagger Documentation with Node & Express

Autogenerating Swagger Documentation with Node & Express

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
  1. With Nodemon installed, start the server using Nodemon
nodemon app.js

OR

npm run start:dev

Using Docker

I prefer to use Docker for local development wherever possible. This allows me to have a consistent development environment.

Start Docker Container

With Docker installed, we can start a container using the latest NodeJS Docker image.

docker run -it --rm -p 5000:5000 -v $(pwd):/api -w="/api" node bash

Start the application in development mode using Nodemon inside your Docker Container

npm run start:dev

To stop your running NodeJS API server

ctrl + c

To quit your Docker Container development environment, in your terminal:

exit

This will cleanup any running containers, (note: the Docker image will still exist on your machine)

You can’t perform that action at this time.