通过 Postman 和 coding.net 发布 API
在开发API的过程中,经常需要提供API文档给前台。开发完再写文档,总感觉需要再做一件事,显得有些麻烦。有没有简单的方法,顺带把文档给做了呢?
有的。调试时通过Postman 记录调试结果,上传到coding.net 或者类似平台展示调试的结果,即可形成API 文档和 Mock 站点。
下面做下详细记录:
假设你启动了本地开发的调试服务 http://127.0.0.1:7001
使用Postman测试请求的API, 点击 保存
保存 Sample,作为Mock 返回
点击了 Save as example后页面会跳转到下一步,点击保存Sample
导出Postman格式的API数据
导入API数据到Coding.net
创建API 文档
上传刚刚导出的Postman API数据
发布数据
发布成功后会有一个可供查看的域名,点击Mock API 启动Mock Server
都设置好 后 大功告成
打开 https://xxx.doc.coding.io/ 可以看到 API文档
打开https://xxx.mock.coding.io 可以访问Mock Server
版权声明: 本文为 InfoQ 作者【太极程序员】的原创文章。
原文链接:【http://xie.infoq.cn/article/26b44363d5170b051dcf5c172】。文章转载请联系作者。
评论