作为后端，如何高效优雅地编写接口文档，后端开发完接口才给出接口文档，合理吗？

本人所在的项目组做项目过程中，后端不会先给出接口文档，而是要等他开发完接口才给出 swagger 文档。

作为前端，我的想法是先有文档，就可以确定后端给到的参数，数据结构，对比和我预想的是否一致（我希望能更早发现接口是否满足需求、是否少参数等问题），我并不指望定了文档就不改。相反，我希望早点发现早点改，防止到后面了大家再返工。

某次动工前，问后端要接口文档，但后端貌似不理解，反问“你都开发完了吗？”

想问下，大家的团队都是什么流程？后端开发完接口才给出接口文档，合理吗？

如果不合理，我应该怎么说服后端？

作为后端，编写接口文档向来是一件很头疼的事情。本来就被bug纠缠的很累了，你还让我干这？

其实，你可以试试ApiPost。

ApiPost的定位是Postman+Swagger+Mock Server，主要用来发送调试接口和生成接口文档。如果你愿意，也可以用它生成Mock 数据，当Mock Server使用。

下面就简单介绍如何利用ApiPost调试接口和快速的生成接口文档，让您初步体验ApiPost的魅力！

1. API写完想要测试？试试模拟发送一次请求

新建接口，我想模拟发送请求如下

curl --location --request POST 'https://echo.apipost.cn/get.php?c=Course&id=1000' \
--header 'User-Agent: Apipost client Runtime/+https://www.apipost.cn/' \
--header 'Content-Type: application/json' \
--data '{
    "course_id":1
}'

如图进行进行配置：

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

你可以查看返回数据，返回Header、Cookie、状态码、请求时长等等数据。

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

点击分享文档

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

3. 后记

恭喜你体验了第一个接口文档的旅程。我们的工具同时节省了前后端的开发以及沟通时间。

除此之外我们还有更多更好的功能等您来体验。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。