postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown
作者:mmseoamin日期:2024-02-06


保存、补全尽可能多的数据、描述

保存响应数据 Response:(如果导出接口数据,会同步导出响应数据)

请求接口后,点击下方 Save as Example  可以保存响应数据到本地(会在左侧接口下新增一个e.g. 文件用来保存响应数据)

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第1张

完善文档相关信息 :接口名、参数描述、自定义文档

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第2张

自定义文档:可使用默认编辑方式,也可以使用markdown方式编辑文档 

 postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第3张

文档方式展示接口 

Collections 项目或中文件夹  -  。。。 (功能小按钮)  -  view documentation :

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第4张

​​​​​​​导出:导出为json文件

导出方式1:上图右侧 View Collection  -  下图右侧 : 。。。 (文档 功能小按钮)  -  Export :

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第5张

 导出方式2:项目  -   。。。(功能小按钮)  -  Export :

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第6张

直接 Export :导出json脚本

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第7张

 保存json

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第8张

导入json脚本

Import  -  弹窗 files:

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第9张

如果存在同名项目,会提示替换 或 拷贝导入:导入成功。

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第10张

=================================================

使用showdoc

https://www.showdoc.com.cn/

创建项目

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第11张

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第12张

导入postman的json脚本

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第13张

注意:showdoc从postman json导入生成的文档中,获取不到请求参数值,这个可能需要手动填入 或 其他方式导入?

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第14张

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第15张

导出word 或 markdown 文件

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第16张

最终文档

postman 文档、导出json脚本 导出响应数据 response ,showdoc导入postman json脚本 导出为文档word或markdown,第17张​​​​​​​

或者使用 apifox(待补充)

​​​​​​​https://apifox.com/apiskills/export-and-use/