{"repo":"syroegkin/swagger-markdown","free":true,"listed":false,"github":"https://github.com/syroegkin/swagger-markdown","clone":"git clone https://github.com/syroegkin/swagger-markdown.git","description":"swagger to markdown transpiler","language":"TypeScript","stars":266,"topics":["swagger","javascript","markdown","node","nodejs","js","openapi"],"license":"MIT","category":"api-integrations-sdks","readme_excerpt":"swagger-markdown [![npm][npm-image]][npm-url] [![circle ci][circleci-image]][circleci-url] CLI script to turn Swagger/OpenAPI specifications into Markdown files. Supports Swagger 2.0, OpenAPI 3.0.x, and OpenAPI 3.1.x. For 3.1, webhooks are included in the generated documentation. 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. The --force-version flag is now obsolete and will be removed in a future release. see examples folder Installation Usage Npx (requires no installation) Example 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: Related swagger-markdown-ui (source) [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","default_branch":null,"files":null,"tree":[],"storefront":"/r/syroegkin","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/syroegkin/swagger-markdown/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}