syroegkin / Swagger Markdown
Licence: mit
swagger to markdown translater
Stars: ✭ 127
Programming Languages
javascript
184084 projects - #8 most used programming language
js
455 projects
Projects that are alternatives of or similar to Swagger Markdown
Wizard
Wizard是一款开源的文档管理工具,支持Markdown/Swagger/Table类型的文档。
Stars: ✭ 1,733 (+1264.57%)
Mutual labels: swagger, markdown
Ginrpc
gin auto binding,grpc, and annotated route,gin 注解路由, grpc,自动参数绑定工具
Stars: ✭ 157 (+23.62%)
Mutual labels: swagger, markdown
Swagger2markup
A Swagger to AsciiDoc or Markdown converter to simplify the generation of an up-to-date RESTful API documentation by combining documentation that’s been hand-written with auto-generated API documentation.
Stars: ✭ 2,330 (+1734.65%)
Mutual labels: swagger, markdown
Faygo
Faygo is a fast and concise Go Web framework that can be used to develop high-performance web app(especially API) with fewer codes. Just define a struct handler, faygo will automatically bind/verify the request parameters and generate the online API doc.
Stars: ✭ 1,557 (+1125.98%)
Mutual labels: swagger
Lessmd
A small markdown viewer/converter for unix terminal.
Stars: ✭ 122 (-3.94%)
Mutual labels: markdown
Woofmark
🐕 Barking up the DOM tree. A modular, progressive, and beautiful Markdown and HTML editor
Stars: ✭ 1,594 (+1155.12%)
Mutual labels: markdown
Honkit
📖 HonKit is building beautiful books using Markdown - Fork of GitBook
Stars: ✭ 1,901 (+1396.85%)
Mutual labels: markdown
Gin Swagger
gin middleware to automatically generate RESTful API documentation with Swagger 2.0.
Stars: ✭ 2,001 (+1475.59%)
Mutual labels: swagger
Docs
Official repository containing all docs & guides of OVH Group
Stars: ✭ 126 (-0.79%)
Mutual labels: markdown
Client Python
A python client library for accessing Polygon's APIs
Stars: ✭ 127 (+0%)
Mutual labels: swagger
Tsed
📐 Ts.ED is a Node.js and TypeScript framework on top of Express to write your application with TypeScript (or ES6). It provides a lot of decorators and guideline to make your code more readable and less error-prone.
Stars: ✭ 1,941 (+1428.35%)
Mutual labels: swagger
Zero Rails openapi
Concise DSL for generating OpenAPI Specification 3 (OAS3) JSON documentation for Ruby application.
Stars: ✭ 125 (-1.57%)
Mutual labels: swagger
Http Router
🎉 Release 2.0 is released! Very fast HTTP router for PHP 7.1+ (incl. PHP8 with attributes) based on PSR-7 and PSR-15 with support for annotations and OpenApi (Swagger)
Stars: ✭ 124 (-2.36%)
Mutual labels: swagger
Grpc Gateway
The gRPC-Gateway is a plugin of the Google protocol buffers compiler
protoc.
It reads protobuf service definitions and generates a reverse-proxy server which
translates a RESTful HTTP API into gRPC. This server is generated according to the
google.api.http
annotations in your service definitions.
Stars: ✭ 12,223 (+9524.41%)
Mutual labels: swagger
Press
Cross-platform markdown editor written in Kotlin Multiplatform (work in progress)
Stars: ✭ 1,748 (+1276.38%)
Mutual labels: markdown
swagger-markdown
CLI script to turn swagger yaml into markdown files. Supports swagger 2.0 format only
see examples folder
Installation
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.
Npx (requires no installation)
npx swagger-markdown -i ./basic-auth.yaml
Example
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:
npm i --save-dev swagger-markdown
{
"scripts": {
"md-docs": "swagger-markdown -i path/to/swagger.yaml",
//...
}
}
npm run md-docs
Related
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].