一、约定说明¶

1.1 参数说明¶

请求方式：本框架规定了所有请求参数所配置的方式以及用途：

参数位置	Content-Type	编码方式	举个例子	说明
path	–	–	/url/{user}/{uid}	拼接在url内
query	–	–	/url/user?uid=10	拼接在?后
body	application/x-www-form-urlencoded	x-www-form-urlencoded	‘uid=100&sex=1’	表单提交，推荐
body	application/json	x-www-form-urlencoded	‘uid=100&sex=1’	json提交
body	multipart/form-data	form-data	{“file”: open(“../demo.jpg”)}	上传文件

1、path：参数被设置在请求url内；如”/url/xxx/yyy”。注意，使用该模式，框架不会自动收集参数，即self.params永远为空
2、query：参数被设置在?后面：如”/url?xxx=111&yyy=222”
3、body-json: json提交，参数以json的格式被设置在body内，body设置为x-www-form-urlencoded，Content-Type设置为”application/json”。注意该模式与body-form不能同时设置。
4、body-form：表单提交，参数以kv的格式被设置在body内，body设置为x-www-form-urlencoded，Content-Type设置为”application/x-www-form-urlencoded”。注意该模式与body-json不能同时设置。
5、file：上传文件。body设置为form-data，Content-Type设置为”multipart/form-data;boundary=abcefxxx”,boundary通常会自动被设置为一个随机字符

注意：以上345模式，由于值都被设置在body内，所以在同一api内，对于不同的参数，不允许混用不同的模式。唯一的例外是，file模式下（multipart/form-data），既允许同时上传文件，又允许设置其他参数。

参数值类型：在设置schema.yml时，指定type的值允许是以下几种之一

类型	说明
int	整形
float	浮点型
str	字符串
list	数组（不推荐)
json	json串
file	文件

1.2 headers¶

API请求时，需要提供请求头

headers：

{
    "uid": 用户uid, int,  注册成功、登录成功后返回
    "token": 授权码, str, 注册成功、登录成功后返回
    "locale": "cn",
    "lang": "",
    "version": "", 默认 1.0
    "bundle": "",
    "platform": 0 IOS, 1 Android
    "os": "",
    "device_id": ""
}

1.3 API 返回结果¶

所有http_status响应值为200的请求，仅代表本次HTTP请求响应成功。返回以下2种结果之一：

当error=0时，代表应用服务器处理成功，客户端可以正常处理data
当error!=0时，代表应用服务器处理失败，error即为对应的异常码。
msg：字段为本次请求的提示信息
data：为本次请求返回的数据

result:

成功：{"error": 0, "msg": msg, "data": {}}
失败：{"error": 1, "msg": msg, "data": {}}

1.4 双向校验码seq生成¶

部分防刷接口需要提供参数seq，生成方法如下

salt：写死在客户端

例如：
params={"nickname": "阿刘", "age": "111", "timestamp": 1473761433}
上述2个参数value 均为 utf-8 编码, 根据key的字典顺序排序 键和值之间用"="连接 键值对之间用"&"连接,
生成待校验的字符串string, string 与 salt 字符串 拼接,计算校验码：
seq = md5(salt + "nickname=阿刘&age=111&timestamp=1473761433")
注：凡需要传seq的接口，必须同时提供请求时间戳参数：timestamp

1.5 翻页码规则：仅支持查看下一页，不支持跳页¶

参数名：last_id，由服务器返回。客户端可以在请求列表时，回传给服务端，

1、当不提供该参数时，代表查看第一页
2、当服务端返回last_id=-1时，代表没有下一页了

1.6 域名配置¶

api：http://api.domain.com admin 接口：http://xx.domain.com docs文档：http://docs.domain.com