Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 

readme.md

Swagger Components Installation

npm i glob swagger-jsdoc swagger-ui-express @types/swagger-jsdoc @types/swagger-ui-express
npm update

Run server

npm run dev

Build server

npm run build

OpenAPI Documentation

The swagger.json file can be retrieved at http://localhost:3000/swagger.json

Advantages

  • No post-editing to the generated OpenAPI documentation is required.

Disadvantage

  • Steep learning curve on OpenAPI specification is required as the correct format must be used when annotating the source code.