api文档格式

api文档格式

可用格式为:JSON-LD,GraphQL,JSON,JSON:API,HAL,XML,YAML,CSV,HTML(API文档)。

tn : totalNumber => 总条数

sn : sizeNumber => 分页阈值

cn : currentNumber => 当前页数

pn : pageNumber => 总页数

q : query => 查询参数

asc: 1/0 => 升序/降序

code: 业务约定,0为正确,其他为错误

orderBy: key => 以 key 作为排序参数

需要注意的点

所有资源 ID 对当前接口返回统一命名为 id

数据库操作 下划线 连接所有对外字段,全部改为小驼峰