您可以使用 Postman 官方提供的工具或第三方工具将 Collection 文件转换为 Markdown 文件。
方式一
Postman 官方提供的工具是 Newman,它是一个命令行工具,可以帮助您运行和测试 Postman Collection,还可以将 Collection 转换为多种格式,包括 Markdown。以下是 Newman 转换 Collection 为 Markdown 文件的具体步骤:
- 安装 Node.js 和 Newman。
- 打开终端或命令行窗口,输入以下命令转换 Collection 为 Markdown 文件:
newman run [collection file] --export-github md --export-github-out [output file]
其中,[collection file] 是 Collection 文件的路径,[output file] 是导出的 Markdown 文件的路径和文件名。
- 执行命令后,Newman 将运行 Collection 并将其转换为 Markdown 文件。
方式二
第三方工具也可以将 Collection 文件转换为 Markdown 文件。其中较为流行的工具是 postman-to-markdown,它是一个 Node.js 模块,可以将 Postman Collection 转换为 Markdown 文件。以下是使用 postman-to-markdown 转换 Collection 为 Markdown 文件的具体步骤:
- 安装 Node.js 和 postman-to-markdown。
- 打开终端或命令行窗口,输入以下命令安装 postman-to-markdown:
npminstall-g postman-to-markdown
- 输入以下命令将 Collection 转换为 Markdown 文件:
postman-to-markdown [collection file]>[output file]
其中,[collection file] 是 Collection 文件的路径,[output file] 是导出的 Markdown 文件的路径和文件名。
- 执行命令后,postman-to-markdown 将运行 Collection 并将其转换为 Markdown 文件。
请注意,在转换 Collection 为 Markdown 文件之前,请确保 Collection 文件包含了适当的描述和注释,以便其他人可以理解您的接口。
版权归原作者 一点博客 所有, 如有侵权,请联系我们删除。