怎么写接口文档

一些刚开始写接口文档的服务端同学，很容易按着代码的思路去编写接口文档，这让客户端同学或者是服务对接方技术人员经常吐槽，看不懂接口文档。这篇文章提供一个常规接口文档的编写方法，给大家参考。 一、请求参数 1. 请求方法 GET 用于获取数据 POST 用于更新数据 PUT 用于新增数据 DELETE 用于删除数据 其他 其他的请求方法在一般的接口中很少使用。如：PATCH HEAD OPTIONS

>>阅读原文<<