阅读量:3
在Linux用Postman创建API文档可参考以下方法:
使用Postman界面
- 创建集合:打开Postman,创建新集合来组织API请求。
- 添加请求并描述:在集合中添加API请求,为每个请求添加详细描述、参数、请求头、请求体及预期响应等信息,还可生成成功、失败和异常示例。
- 预览文档:在集合选项中点击“View in Web”,在线预览文档。
- 发布文档:点击“Publish Docs”生成公开URL,方便他人访问。
- 导出文档:选择集合,点击“导出”,选Markdown等格式,勾选“包含示例”和“包含描述”后导出。
使用命令行工具(newman)
- 安装依赖和工具:安装
libgconf-2-4,下载Postman CLI工具并解压,创建符号链接。 - 生成文档:使用
newman run命令,指定集合文件、环境文件和输出路径来生成HTML文档。
以上就是关于“如何在Linux用Postman创建API文档”的相关介绍,筋斗云是国内较早的云主机应用的服务商,拥有10余年行业经验,提供丰富的云服务器、租用服务器等相关产品服务。云服务器资源弹性伸缩,主机vCPU、内存性能强悍、超高I/O速度、故障秒级恢复;电子化备案,提交快速,专业团队7×24小时服务支持!
简单好用、高性价比云服务器租用链接:https://www.jindouyun.cn/product/cvm