API规范

Create

请求方法：POST
请求参数：创建的对象
示例： /pets/types
响应Code：201
响应体：完整对象，包括主键

Update

全量更新：PUT 未提供
局部更新：PATCH
请求参数：需要包含主键
示例： /pets/types/{id}
响应Code：200
响应体：完整对象

Delete

请求方法：DELETE
请求参数：主键，在链接中
示例： /pets/types/{id}
响应Code：204
无响应体

Research

请求方法：GET

请求参数:

• Query:

  • .maxResults 最大单次获取数量，默认 10

  • .offset 跳过数量 默认0

  • .sort 排序，传字段名，加 - 表示倒序，如 -created_at ，表示按创建时间倒序

  • {field}_{op} {field}表示字段名称, {op} 表示操作符，支持lt, lte, gt, gte, in, not , like

  • {field} 根据{field}字段等于操作的过滤查询

例：/pets/attrs?.maxResults=10&.offset=10&.sort=created_at&pet_type_id=1&created_at_gte=2019-05-01

http://47.103.17.61/protect/orders?access_token=ACCESS_TOKEN&.includes=pet,address,product&status=未支付

响应Code：200
响应体：

{
    "data":[{},{}],
    "total":100
}

错误响应

响应Code：400、500类错误码
响应体：

{
    "message":""
}

发送成功的响应示例

{"Message":"OK","RequestId":"D57EC9EC-1ABB-420C-9EC1-859C97235A04","BizId":"814601564746005009^0","Code":"OK"}