express-oas-generator

(β˜… 232)

OpenAPI (Swagger) specification generator for ExpressJS applications

  • .eslintrc.js
  • .gitignore
  • .travis.yml
  • article.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • index.d.ts
  • index.js
  • jsdoc.json
  • LICENSE
  • package-lock.json
  • package.json
  • README.md
  • server_advanced.js
  • server_basic.js
  • tsconfig.json

# Installation Guide

1. Get the code
git clone https://github.com/mpashkovskiy/express-oas-generator

Downloads the entire project code from GitHub to your computer.

cd express-oas-generator

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.
// repository documentation