API通用封装说明

基本结构：

{
    "status":1,
    "error":"",
    "data":{
         ...
    },
    "req_id":"911adb2c1ea7d511"
}
                

如上所示，是所有API返回的基本封装形式，其字段说明如下：

字段	类型	说明
status	INT	响应状态，但且仅当status=1时候表示API逻辑成功执行且正常返回数据， 该值会根据业务的不同返回不同的值，通常为出错的0和成功的1。
error	String	当status字段返回值不是1时候，该字段保护请求出错的信息，status的值为1该字段值为空（''）无意义，为了固定格式封装还是返回一个空值，可不理会。
data	String	当status字段的值为1时候（业务处理成功），该字段方有意义，所有的数据都会包含在该字段中，如果是列表通常包含rows作为列表记录的父节点， total表示所有记录数，count表示当前rows中的记录记录数。
req_id	String	请求ID，当出错或读请求有疑问时候，可凭借该请求ID查询到请求的相关业务信息，用于查错。

HTTP状态码：

在正常的业务逻辑中，无论是处于何种情况，API永远返回200的HTTP状态码，如果不是200，说明可能由于内部服务器错误造成的500错误等不可控制因素影响，程序并未正常执行，为非预期情况。

返回数据格式：

JSON，没错，所有文本类型的数据都是以JSON格式返回。

关于RESTFul：

本平台API没有采用时下最流行的RESTFul风格的API形式，而采用比较传统的固定格式封装的形式，虽然不是很优雅，但用起来也还行。