当前位置:   article > 正文

Postman导出JSON文件轻松转换为HTML或Markdown_json格式的接口文档怎么处理

json格式的接口文档怎么处理

Postman 想必大家都不陌生,在软件开发和API测试的过程中,Postman 已经成为了一个不可或缺的工具。它不仅可以帮助我们设计、发送、测试和调试 HTTP 请求,还可以轻松地导出接口数据为JSON格式。然而,有时候为了更直观地向团队成员展示接口信息,即文档化,我们可能需要将这些JSON数据转换为更易于阅读的格式,如 HTML 或 Markdown

你们可能会问了,不是有专门的接口文档管理工具吗,像 Swagger 之类的,咋不用呢?底层小测试用什么 Swagger,哪个方便用哪个。

图片

为什么要将JSON转换为HTML或Markdown

我们都知道,Postman 只能导出 JSON 格式的文件,从易读性和直观性来讲,不是很方便,如果别人想看你的接口信息,只能将 JSON 文件导入 Postman。鉴于此,我们可以将 JSON 转换为 HTML 或 Markdown

HTML 格式使得数据可以在网页浏览器中呈现,这对于展示复杂的嵌套数据或构建可视化报告非常有用。

Markdown 是一种轻量级的标记语言,它允许你使用简单的文本格式来编写文档,这些文档可以被转换为结构化的 HTMLMarkdown 格式非常适合编写技术文档或报告,因为它既易于阅读又易于编写。

图片

如何使用Postman将JSON转换为HTML或Markdown

Postman 本身并不直接支持将 JSON 转换为 HTML 或 Markdown,但你可以借助一些第三方工具或脚本来实现这一功能。我们可以使用免费的开源工具 docgen 来实现这一功能。

docgen 安装和卸载

1.工具链接

https://github.com/thedevsaddam/docgen

图片

2.安装

  • • Mac/Linux 安装

  1. curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh \
  2. && sudo chmod +x install.sh \
  3. && sudo ./install.sh \
  4. && rm install.sh
  • • Mac/Linux 卸载

  1. curl https://raw.githubusercontent.com/thedevsaddam/docgen/v3/uninstall.sh -o uninstall.sh \
  2. && sudo chmod +x uninstall.sh \
  3. && sudo ./uninstall.sh \
  4. && rm uninstall.sh
  • • Windows:直接下载二进制文件并设置环境变量。下载链接:https://github.com/thedevsaddam/docgen/releases

图片

JSON 转换 HTML 和 Markdown

1.从 Postman 导出为 JSON 文件

图片

2.JSON 转换 HTML 和 Markdown

  • • 查看实时在线 HTML 文档

docgen server -f ~/Downloads/Api_Test_postman_collection.json -p 8000

图片


图片

  • • 查看实时在线 Markdown 文档

docgen server -f ~/Downloads/Api_Test_postman_collection.json -p 8000 -m

图片


图片

  • • 生成本地 HTML 文档

docgen build -i ~/Downloads/Api_Test_postman_collection.json -o ~/Downloads/Api_Test_postman_collection.html

图片


图片

  • • 生成本地 Markdown 文档

docgen build -i ~/Downloads/Api_Test_postman_collection.json -o ~/Downloads/Api_Test_postman_collection.md -m

图片


图片

注意事项

在使用第三方工具 docgen 时,注意查看其文档和使用说明,以确保正确使用。通过上述方法,你可以轻松地将 Postman 导出的 JSON 文件转换为 HTML 或 Markdown 格式的文件,从而更方便地分享和展示 API 文档。

行动吧,在路上总比一直观望的要好,未来的你肯定会感 谢现在拼搏的自己!如果想学习提升找不到资料,没人答疑解惑时,请及时加入扣群: 320231853,里面有各种软件测试+开发资料和技术可以一起交流学习哦。

最后感谢每一个认真阅读我文章的人,礼尚往来总是要有的,虽然不是什么很值钱的东西,如果你用得到的话可以直接拿走:

这些资料,对于【软件测试】的朋友来说应该是最全面最完整的备战仓库,这个仓库也陪伴上万个测试工程师们走过最艰难的路程,希望也能帮助到你!

声明:本文内容由网友自发贡献,不代表【wpsshop博客】立场,版权归原作者所有,本站不承担相应法律责任。如您发现有侵权的内容,请联系我们。转载请注明出处:https://www.wpsshop.cn/w/羊村懒王/article/detail/631746
推荐阅读