保存、补全尽可能多的数据、描述
保存响应数据 Response:(如果导出接口数据,会同步导出响应数据)
请求接口后,点击下方 Save as Example 可以保存响应数据到本地(会在左侧接口下新增一个e.g. 文件用来保存响应数据)
完善文档相关信息 :接口名、参数描述、自定义文档
自定义文档:可使用默认编辑方式,也可以使用markdown方式编辑文档
文档方式展示接口
Collections 项目或中文件夹 - 。。。 (功能小按钮) - view documentation :
导出:导出为json文件
导出方式1:上图右侧 View Collection - 下图右侧 : 。。。 (文档 功能小按钮) - Export :
导出方式2:项目 - 。。。(功能小按钮) - Export :
直接 Export :导出json脚本
保存json
导入json脚本
Import - 弹窗 files:
如果存在同名项目,会提示替换 或 拷贝导入:导入成功。
=================================================
使用showdoc
https://www.showdoc.com.cn/
创建项目
导入postman的json脚本
注意:showdoc从postman json导入生成的文档中,获取不到请求参数值,这个可能需要手动填入 或 其他方式导入?
导出word 或 markdown 文件
最终文档
或者使用 apifox(待补充)
https://apifox.com/apiskills/export-and-use/