https://github.com/maxdome/mxd-swagger
https://github.com/maxdome/mxd-swagger
Last synced: 9 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/maxdome/mxd-swagger
- Owner: maxdome
- Created: 2016-09-29T12:24:49.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2017-02-06T09:52:28.000Z (over 9 years ago)
- Last Synced: 2025-08-09T11:32:56.799Z (10 months ago)
- Language: JavaScript
- Size: 6.84 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Example
Its only needed if you don't use the `mxd-environment`.
```
require('mxd-swagger')(app, express);
```
The Swagger definition file should be located under `config/swagger.json` or `config/swagger.yml`.
# Routes
* `/api-docs`: The swagger API documentation as JSON or YML
* `/docs`: The swagger UI