如何把PostMan导出的json文件生成md或html的接口文档

1.下载docgen插件并改名

下载地址 : https://github.com/thedevsaddam/docgen

如何把PostMan导出的json文件生成md或html的接口文档_第1张图片

下载完成后修改名字: docgen (D:\software\docgen 路径放在系统环境变量path下也行/不放也行 随个人)

如何把PostMan导出的json文件生成md或html的接口文档_第2张图片

如何把PostMan导出的json文件生成md或html的接口文档_第3张图片

2.执行获得生成的接口文档

(未添加进系统环境变量的)在当前目录下执行cmd 然后输入docgen

如何把PostMan导出的json文件生成md或html的接口文档_第4张图片

生成接口文档指令

  • 要查看来自postman集合的实时 HTML 文档,请使用…这将打开postman集合的 html 版本到定义的端口

    docgen server -f json文件地址 -p 8000
    
  • 从postman集合查看实时 Markown 文档使用…这将打开邮递员集合的降价版本到定义的端口

    docgen server -f json文件地址 -p 8000 -m
    
  • 生成HTML 文档使用

    docgen build -i json文件地址 -o html文件地址和文件名
    
  • 生成Markdown 文档使用

    docgen build -i input-postman-collection.json -o md格式文件地址和文件名 -m
    

举例:

docgen server -f C:\Users\admin\Desktop\api\api.json -p 8000
docgen server -f C:\Users\admin\Desktop\api\api.json -p 8000 -m
docgen build -i C:\Users\admin\Desktop\api\api.json -o C:\Users\admin\Desktop\api\api.html
docgen build -i C:\Users\admin\Desktop\api\api.json -o C:\Users\admin\Desktop\api\api.md -m

你可能感兴趣的:(PostMan,PostMan)