阅读量:2
在Ubuntu上使用Postman生成接口文档,主要有以下两种方法:
- 使用Postman界面生成:
- 创建接口集合,添加API请求并为每个请求添加详细描述、参数、请求头和请求体等信息。
- 为接口生成成功、失败和异常样例。
- 点击集合的“View in Web”预览文档,或点击“Publish Docs”发布文档获取公开URL。
- 使用第三方工具生成:
- 安装docgen工具:
wget https://raw.githubusercontent.com/thedevsaddam/docgen/v3/install.sh -o install.sh && sudo chmod +x install.sh && sudo ./install.sh && rm install.sh。 - 从Postman导出集合为JSON文件。
- 使用
docgen build -i命令生成Markdown文档,或使用-o <输出文件路径> -m docgen server -f在线预览HTML文档。-p <端口号>
- 安装docgen工具:
以上就是关于“Ubuntu上Postman的接口文档生成”的相关介绍,筋斗云是国内较早的云主机应用的服务商,拥有10余年行业经验,提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩,主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复;电子化备案,提交快速,专业团队7×24小时服务支持!
简单好用、高性价比云服务器租用链接:https://www.jindouyun.cn/product/cvm