2022年2022年接口文档设计规范 2.pdf

《2022年2022年接口文档设计规范 2.pdf》由会员分享，可在线阅读，更多相关《2022年2022年接口文档设计规范 2.pdf（3页珍藏版）》请在淘文阁 - 分享文档赚钱的网站上搜索。

1、接口文档设计分为两部分：一、对外接口设计规范，1. 提供完整的接口文档2. 提供接口调用的代码Demo 示例如下：请求的基本参数参数参数名称类型（长度范围）参数说明是否可为空样例基本参数接口名称String(64) 不可空send_goods_confirm_by_platform 合作者身份ID String(16) 可空2088001159940003 参数编码字符集String(10) 不可空GBK 签名String(64) 不可空e8qdwl9caset5zugii2r7q0k8ikopxor 签名方式String(10) 不可空MD5 页面跳转同步返回页面路径String(1000)

2、 可空备注String(1000) 可空同步返回时，需要的基本参数参数参数名称类型（长度范围）参数说明是否可为空样例基本参数成功标识String(1) 不可空T 合作者身份ID String(16) 可空2088001159940003 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 1 页，共 3 页 - - - - - - - - - 参数编码字符集String(10) 不可空GBK 签名String(64) 不可空e8qdwl9caset5zugii2r7q0k8ikopxor

3、 签名方式String(10) 不可空MD5 返回错误码String(30) 可空PARTNER_ID_NOT_EXIST 返回错误原因String(200) 可空合作方 Id 不存在备注String(1000) 可空二、内部接口规范，1. 发布 fa?ade 接口 jar 包，包含了API 、request 、 response 2. 提供接口对应的response返回码说明，及接口所需属性枚举常量定义示例如下：接口名称 : XXXXXXXXXXXXXXX 请求参数属性描述是否必填字段类型Y String(32) Y String(32) Y String(32) Y String(32)

4、Y String(32) Y Money N String(32) N String(32) N String(2) N String(32) N String(32) N String(64) N String(256) 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 2 页，共 3 页 - - - - - - - - - N String(12) N String(64) N String(64) N String(1) String(1) N String(256) N String(2000) 返回参数属性描述是否必填字段类型返回码Y String 返回信息N String 扩展信息N String 名师资料总结 - - -精品资料欢迎下载 - - - - - - - - - - - - - - - - - - 名师精心整理 - - - - - - - 第 3 页，共 3 页 - - - - - - - - -