接口文档设计规范.doc

接口文档设计规范.doc接口文档设计分为两部分:
一、对外接口设计规范，
提供完整的接口文档
提供接口调用的代码Dem。
示例如下：
请求的基本参数
参
参数名称
类型
参数
是否可
样例
数
（长度范围）
说明
为空
基本参数
接口名称
String(64)
不可空
send_goods_confirm_by_platform
合作者身份ID
String(16)
可空
2088001159940003
参数编码字符集
String(10)
不可空
GBK
签名
String(64)
不可空
e8qdwl9caset5zugii2r7q0k8ikopxor
签名方式
String(10)
不可空
MD5
页面跳转同步返 回页面路径
String(IOOO)
可空
备注
String(IOOO)
可空
同步返回时，需要的基本参数
参
数
参数名称
类型
（长度范围）
参数说 明
是否可 为空
样例
基本参数
成功标识
String ⑴
不可空
T
合作者身份
ID
String(16)
可空
2088001159940003
参数编码字
符集
String(1O)
不可空
GBK
签名
String(64)
不可空
e8qdwl9caset5zugii2r7q0k8ikopxor
签名方式
String(1O)
不可空
MD5
返回错误码
String(30)
可空
PARTNE R_l D_NOT_EX 1ST
返回错误原 因
String(200)
可空
合作方Id不存在
备注
String(IOOO)
可空
二、内部接口规范，
发布 fagade 接口 jar 包，包含了 API、request、response
提供接口对应的response返回码说明，及接口所需属性枚举常量定义
示例如下:
接口名称：
XXXXXXXXXXXXXXX
请求参数
属性
描述
是否必填
字段类型
Y
String(32)
Y