接口文档设计指南

考虑的方面：

1）服务器；

2）数据及格式；

3）安全；

4）会话及响应码。

host地址

测试环境:
准生产环境:
生产环境:

本文档使用 host/requestPath 的形式描述请求路径。

数据安全

采用https信道加密技术来保证通信安全；
其它安全措施，待定；

通信协议与数据格式

1）所有客户端请求数据使用post方式发送；
2）报文数据使用json封装；http Content-Type选项为application/json。

报文格式说明

请求格式

{
    param1:value1,
    ........
    paramn:valuen,
}

响应格式

{
    respCode:code,
    respMsg:msg,
    respData:{},
}

respCode说明

code	说明
0	成功
100	参量错误
300	服务不可用（访问路径错误、无访问权限）

请求报文通用参量

参量名称	说明	类型
apiVersion	服务器api版本号	string
appVersion	客户端版本号	string
deviceId	设备id	string

登录接口

requestPath：login

请求参量

参量名称	说明	类型
userName	用户名	string
passWord	md5(真实的用户密码)	string

说明：用户的登录状态与设备绑定；以便完成推送功能和踢出登录功能。

respData参量： 无

退出登录接口

requestPath：logout

参量名称	说明	类型
userName	用户名	string

respData参量： 无

转载于:https://www.cnblogs.com/feng9exe/p/7127753.html