express-jsdoc-swagger

(★ 224)

Swagger OpenAPI 3.x generator

File Explorer

Download Latest Version (.zip)

- - bug_report.md
  - feature_request.md
- - npm-publish.yml
  - runTests.yml
- FUNDING.yml
- PULL_REQUEST_TEMPLATE.md
- default.js
- swaggerEvents.js
- - getComments.js
  - readFile.js
- getOnlyComments.js
- globFilesMatches.js
- jsdocInfo.js
- readFiles.js
- - index.js
- - enum.js
  - simple.js
- - index.js
  - main.js
  - multiple-files.txt
  - multipleFiles.js
  - swaggerOptions.js
- - index.js
  - multipleInstance.js
- - simple.js
  - swagger.js
- - explicitNullable.js
  - nullableByDefault.js
- - components.js
  - enum.js
  - headers.js
  - multiple.js
  - simple.js
- - components.js
  - formdata.js
  - formParameters.js
  - formUrlencoded.js
  - multiple.js
  - simple.js
  - withExamples.js
- - components.js
  - full-example.js
  - multiple.js
  - simple.js
  - withExamples.js
- - basic-auth.js
  - basic-oauth2.js
  - swagger.json
- - simple.js
- - nodemon.json
  - package-lock.json
  - package.json
  - README.md
  - simple.ts
  - tsconfig.json
- - logger.js
- - app.js
  - index.js
  - validator.js
- package-lock.json
- package.json
- README.md
- - events.test.js
- - contact.js
  - index.js
  - info.js
  - license.js
  - servers.js
- - index.js
- - content.js
  - examples.js
  - formParams.js
  - index.js
  - parameters.js
  - requestBody.js
  - responses.js
  - schema.js
  - security.js
  - validStatusCodes.js
- - index.js
- - index.js
- - arrays.js
  - combineSchema.js
  - enumValues.js
  - errorMessage.js
  - formatDescription.js
  - formatExamples.js
  - generator.js
  - httpMethods.js
  - mapDescription.js
  - refSchema.js
  - setProperty.js
  - tags.js
  - validateTypes.js
- index.js
.all-contributorsrc
.eslintignore
.eslintrc.json
.gitignore
.npmignore
CODE_OF_CONDUCT.md
commitlint.config.js
CONTRIBUTING.md
index.d.ts
index.js
LICENSE.md
package-lock.json
package.json
processSwagger.js
README.md
swaggerEvents.js

# Installation Guide

1. Get the code

git clone https://github.com/BRIKEV/express-jsdoc-swagger

Downloads the entire project code from GitHub to your computer.

cd express-jsdoc-swagger

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 i express-jsdoc-swagger

Type this command into your terminal and run it.

npm install --save express-oas-validator

Downloads and installs the libraries listed in package.json.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

Pulled directly from this repo's README.