Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/syroegkin/swagger-markdown
swagger to markdown transpiler
https://github.com/syroegkin/swagger-markdown
javascript js markdown node nodejs openapi swagger
Last synced: about 1 month ago
JSON representation
swagger to markdown transpiler
- Host: GitHub
- URL: https://github.com/syroegkin/swagger-markdown
- Owner: syroegkin
- License: mit
- Created: 2016-08-11T21:19:43.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-26T08:29:02.000Z (6 months ago)
- Last Synced: 2024-04-27T09:42:23.893Z (4 months ago)
- Topics: javascript, js, markdown, node, nodejs, openapi, swagger
- Language: TypeScript
- Homepage:
- Size: 2.3 MB
- Stars: 228
- Watchers: 5
- Forks: 85
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# swagger-markdown
[![npm][npm-image]][npm-url] [![circle ci][circleci-image]][circleci-url]
CLI script to turn swagger yaml into markdown files.
Supports swagger 2.0 format only
The version 2.0 is a breaking change. The project was rewritten in typescript.
Along with addressing multiple issues, it is more strict now with the openapi version.
In case if version 3 is provided, the application will throw an error.
The support of v3 is at the roadmap, although it is possible to overcome this restriction by using --force-version flag: `--force-version 2`. It will process v3 documents as it is v2, although it may fail and it may generate the markdown with errors.
As soon as v3 support will be added, the flag will be removed.
see [examples](https://github.com/syroegkin/swagger-markdown/tree/master/examples) folder
### Installation
```bash
npm install -g swagger-markdown
```
### Usage
```
swagger-markdown [-h] [-v] -i [-o] [--skip-info]
Options:
-h, --help Show this help message and exit.
-v, --version Show program's version number and exit.
-i , --input Path to the swagger yaml file
-o , --output Path to the resulting md file
--skip-info Skip the title, description, version etc, whatever is in the info block.
--force-version Set the document version, ignore version provided in the yaml file
```
### Npx (requires no installation)
```bash
npx swagger-markdown -i ./basic-auth.yaml
```
#### Example
```bash
swagger-markdown -i path/to/swagger/file.yaml
```
By default it will create the new file within the same directory with the same name as swagger file but with .md extension.
So, if swagger file is placed in `project/api-doc/swagger.yaml` the new file will be created as `project/api-doc/swagger.md`
You can also use it as a npm script in your package.json:
```bash
npm i --save-dev swagger-markdown
```
```json
{
"scripts": {
"md-docs": "swagger-markdown -i path/to/swagger.yaml",
//...
}
}
```
```bash
npm run md-docs
```
### Related
* [swagger-markdown-ui](https://swagger-markdown-ui.netlify.app/) ([source](https://github.com/shaun-chiang/swagger-markdown-ui))
[npm-url]: https://www.npmjs.com/package/swagger-markdown
[npm-image]: https://img.shields.io/npm/v/swagger-markdown.svg
[circleci-url]: https://circleci.com/gh/syroegkin/swagger-markdown/tree/master
[circleci-image]: https://img.shields.io/circleci/project/syroegkin/swagger-markdown.svg