关于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'

如图进行进行配置：

点击发送，查看接口返回后果：

你能够查看返回数据，返回Header、Cookie、状态码、申请时长等等数据。

2. 测试完后我想疾速生成文档给前端看

点击分享文档

复制并打开文档地址就能够看到了残缺的接口文档。

3. 后记

祝贺你体验了第一个接口文档的旅程。咱们的工具同时节俭了前后端的开发以及沟通工夫。

除此之外ApiPost还有更多更好的性能等您来体验。