API接口文档

情景：公司外呼接口对接东风日产，需要一个任务列表接口和推送任务数据两个接口

文档格式：主要分为三个部分

•    对接文档标题，看一眼就知道这个文档是干嘛的
•    文档变更记录，主要包括  日期、文档版本、变化、变更内容、变更人，顺带附上变更说明，示例如下

• 文档接口，也是主要内容；主要包括以下内容

• 接口名称

• 请求方式--大写

• 请求参数

• 参数名称

• 类型 （分清对象和对象数组的区别）

• 备注

• 请求参数示例代码

• 响应参数

• 参数名称

• 类型

• 备注

• 响应参数示例代码