接口文档规范

接口文档规范
一、环境
测试环境：
预发环境：
正式环境：
MOCK环境：
二、协议和格式
线上环境使用HTTPS协议，以确保交互数据的传输安全，其他环境使用HTTP。
除了URL参数外，一律采用json格式交互。
三、路径规则

例子： (不使用RESTFUL)
GET /product/{id} 获取某个指定商品的信息
POST /product/list 列表查询商品列表
POST /product/page 分页查询商品列表
POST /product 新建一个商品

四、分页
请求参数：

{
    "current":1,
    "size":20
}

返回参数：

{
    "code":"0",
    "serviceCode":"50000000",
    "msg":"成功",
    "data":{
        "records":[
            {
                "companyId":"1253973966258528258"
            }
        ],
        "total":1,
        "size":20,
        "current":1,
        "pages":1
    },
    "success":true
}

五、数据校验
请求头中带 Authorization，用户token信息
六、公共响应参数

{
    "code":"0",
    "serviceCode":"50000000",
    "msg":"成功",
    "data":[
        {
            "areaCode":"37",
            "routeCode":2,
            "status":0,
            "declareType":0,
            "declarePageStatus":0
        }
    ],
    "success":true
}

七、其他
金额：1.00 浮点数
日期：YYYY-MM-DD
时间：YYYY-MM-DD HH:mm:ss