Postman如何生成接口文档

文章内容整理来源 :
https://www.bilibili.com/video/BV1Wy4y1x796?from=search&seid=6351344125475711514

接口工具推荐： ApiPost 接口测试工具，更适合国人的使用习惯，一键生成接口文档，一键导出，不用有postman的麻烦操作。仅供参考。

1,下载docgen插件并改名

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

下载后将插件改名为docgen(建议改名,方便后续操作 , 也可以选择不改名) ,将插件放在C盘docgen文件夹下面(自己随意放也可以 , 注意后面操作的时候改地址)

2.在环境变量中配置docgen插件的路径

在环境变量中进行如下配置 path 上编辑 docgen插件的地址 我的是 C:\docgen

黑窗口启动docgen插件,是否能成功

3.将你在postman中编写的接口导出来

postman中接口导出来后都是 . json的文件

4.生成接口文档

在黑窗口中使用以下语法生成文档:

要查看来自邮递员集合的实时 HTML 文档，请使用docgen server -f json文件地址 -p 8000这将打开邮递员集合的 html 版本到定义的端口

从邮递员集合查看实时 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