swagger转markdown工具（转）

今天要介绍的是nodejs的swagger-markdown

使用

1 首先准备环境，安装nodejs，配置nodejs的环境变量。

// 在命令行下查看node是否安装成功
node -v

2 安装swagger-markdown工具

npm install -g swagger-markdown
swagger-markdown [-h] [-v] -i [-o] [--skip-info]
Options:
  -h, --help      查看帮助信息.
  -v, --version   查看当前swagger-markdown的版本.
  -i , --input    swagger yaml文件的路径
  -o , --output   输出的markdown文件路径

3 准备好swagger-ymal的文件。如果使用的是java的swagger-ui，一般导出来的是json字符串文档，可以使用json-ymal工具转换为ymal内容。

https://www.json2yaml.com/

4 将swagger-ymal文件转换为markdown内容。使用一个ymal的测试内容例子：

运行命令：

swagger-markdown.cmd -i .\test.ymal -o test.md

 

最后

有了好用的工具，写接口文档减少了很多烦恼...