接口文档设计规范
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
接口文档设计分为两部分：
一、对外接口设计规范，
1. 提供完整的接口文档
2. 提供接口调用的代码Demo
示例如下：
请求的基本参数
同步返回时，需要的基本参数
二、内部接口规范，
1. 发布façade接口jar包，包含了API、request、response
2. 提供接口对应的response返回码说明，及接口所需属性枚举常量定义
示例如下：