Skip to content

Example project to generate API docs using swagger, express as server

License

Notifications You must be signed in to change notification settings

nawafilhusnul/swagger-express-typescript

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Swagger - Express : Generating API documentaions - Example

Clone the repository and start using yarn

* yarn install
* yarn dev
* Open http://localhost:3000/api/docs/

Creating Swagger API documentation from multiple yaml files

  1. Add yaml files for defenitions in swagger/definitions/index.yaml
  2. Add yaml files for paths in swagger/paths/index.yaml
  3. Create single json file using swagger-cli command. yarn doc:generate
  4. Serve the html content using swagger-ui-express via express api (refer app.ts)

About

Example project to generate API docs using swagger, express as server

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 100.0%