Skip to content

一个可以将符合 Swagger 2.0 的 JSON 文档转化成较为友好的 Markdown 格式的接口文档的工具。A tool that can convert JSON documents that comply with Swagger 2.0 into more user-friendly markdown format interface documents.

License

Notifications You must be signed in to change notification settings

sliveryou/swag2md

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

swag2md

Github License Go Doc Go Report Github Latest Release Github Latest Tag Github Stars

swag2md 是一个可以将符合 Swagger 2.0 的 JSON 文档转化成较为友好的 Markdown 格式的接口文档的工具。

安装

使用如下命令下载并安装 swag2md 工具:

# 如果 go 版本在 1.16 以前,使用如下命令安装:
$ GO111MODULE=on go get -u github.com/sliveryou/swag2md@latest

# 如果 go 版本在 1.16 及以后,使用如下命令安装:
$ GO111MODULE=on go install github.com/sliveryou/swag2md@latest

或者从 github 的 release 页面下载预编译好的二进制文件。

swag2md 命令行接口

$ swag2md -h  
swag2md 是一个可以将符合 Swagger 2.0 的 JSON 文档转化成较为友好的 Markdown 格式的接口文档的工具

用法:
  swag2md [flags]
  swag2md [command]

例子:
  swag2md -t "接口文档" -s swagger.json -o api.md
  swag2md casbin -s swagger.json -o policy.csv --sub ADMIN --deny

可用命令:
  casbin      生成符合 casbin 规则的 csv 文件
  completion  Generate the autocompletion script for the specified shell
  help        Help about any command

标记:
  -h, --help             help for swag2md
  -o, --output string    解析输出的 markdown 文件的名称 (默认 "auto-gen-api.md")
  -s, --swagger string   待解析的 swagger.json 文件 (默认 "swagger.json")
  -t, --title string     解析输出的 markdown 文件内容的标题 (默认 "接口文档")
  -v, --version          version for swag2md

Use "swag2md [command] --help" for more information about a command.

$ swag2md casbin -h
生成符合 casbin 规则的 csv 文件

用法:
  swag2md casbin [flags]

例子:
  swag2md casbin -s swagger.json -o policy.csv --sub ADMIN --deny

标记:
      --deny            是否需要拒绝选项
  -h, --help            help for casbin
  -o, --output string   解析输出的 csv 文件的名称 (默认 "policy.csv")
      --sub string      casbin 访问实体名称 (默认 "ADMIN")

全局标记:
  -s, --swagger string   待解析的 swagger.json 文件 (默认 "swagger.json")

例子

参考 example 目录下基于 swagger.jsonparser_test.go 生成的文件

PS:

About

一个可以将符合 Swagger 2.0 的 JSON 文档转化成较为友好的 Markdown 格式的接口文档的工具。A tool that can convert JSON documents that comply with Swagger 2.0 into more user-friendly markdown format interface documents.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published