正如每个人都曾回答过三大本我问题:“我是谁?”,“我在哪?”,“我要去哪里?”;一份设计得当的接口文档同样也需要解决它自己的三大问题:“接口是干嘛用的?”,“接口怎么用?”,“使用接口后的返回结果是什么?” 接口文档的组成要素 一份设计得当的接口文档会用自己的方式回答上述问题,它通常会包含以下要素: 接口简介(回答接口是干嘛用的?) 定义请求协议(回答接口怎么用?) 请求地址源 请求方式 请求参数 返回参数示例(回答接口后的返回结果是什么?) 状态码 了解各个要素的含义后便能够清楚地知悉这个接口所能够提供的服务、接口的使用方法。下文将以 Apifox Echo 接口为例,介绍如何读懂一份接...