一个完整的API文档包含的内容

一个完整的API文档应该包含以下几部分： ① 接口名称。 ② 简要描述。 ③ 请求的URL。 ④ 请求方式（GET / POST等）。 ⑤ 请求参数（参数名、是否必选、参数类型、说明）。 ⑥ 返回示例。 ⑦ 返回参数说明（参数名、类型、说明）。 ⑧ 备注及责任人。 内容来源： 有兴趣的可以去读读这本书

>>阅读原文<<