作为一名优秀的Java开发工程师 , 编写接口文档向来是一件很头疼的事情 。 本来就被bug纠缠得很累了 , 你还让我干这?
其实 , 你可以试试ApiPost 。
ApiPost的定位是Postman+Swagger+Mock Server , 主要用来发送调试接口和生成接口文档 。 如果你愿意 , 也可以用它生成Mock 数据 , 当Mock Server使用 。
下面就简单介绍如何利用ApiPost调试接口和快速的生成接口文档 , 让您初步体验ApiPost的魅力!
1. API写完想要测试?试试模拟发送一次请求
新建接口 , 我想模拟发送请求如下
curl –location –request POST ‘http://apis.juhe.cn/mobile/get?phone=13429667914&key=1950d2a44f1b4b9a671d6c53f3d5b6be’
如图进行进行配置:

文章插图
【作为Java开发工程师,如何高效优雅地编写接口文档?】点击发送 , 查看接口返回结果:

文章插图
你可以查看返回数据 , 返回Header、Cookie、状态码、请求时长等等数据 。
2. 测试完后我想快速生成文档给前端看
点击分享文档

文章插图
复制并打开文档地址就可以看到了完整的接口文档 。

文章插图
3. 后记
恭喜你体验了第一个接口文档的旅程 。 我们的工具同时节省了前端的开发以及沟通时间 。
特别声明:本站内容均来自网友提供或互联网,仅供参考,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系,我们将在24小时内删除。
