Skip to content

响应约束

客户端请求头如果没有提供 Accept,默认的响应结果格式应该application/json,否则应该使用请求头中 Accept 指定的格式响应。

  • 响应结果必须使用 HTTP 标准响应码
  • 成功,响应数据为资源本身的描述
  • 失败,响应数据为错误描述,且必须包含 error 对象

响应示例

调用成功:

text
HTTP/1.1 200 OK
Content-Type: application/json
json
{
    "total": 910,
    "items":[{}, {} ...]
}

注:响应体直接是资源数据,没有额外的包装层,采用的是 GitHub REST APIGoogle Resource-oriented design (AIP-121) 最佳实践。

调用失败,详见错误示例

基于 VitePress 构建