https://github.com/princekf/swagger-express-typescript

Example project to generate API docs using swagger, express as server
https://github.com/princekf/swagger-express-typescript

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/princekf/swagger-express-typescript
• Owner: princekf
• License: mit
• Created: 2021-05-24T08:21:19.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2021-05-25T07:53:54.000Z (over 3 years ago)
• Last Synced: 2024-08-13T07:17:37.357Z (5 months ago)
• Language: TypeScript
• Size: 321 KB
• Stars: 3
• Watchers: 1
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - princekf/swagger-express-typescript - Example project to generate API docs using swagger, express as server (TypeScript)

README

        
# 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`)