【数据网关规范】响应格式
设计规范
RESTful API
数据类型
JSON
状态码
作为数据网关面向的是B端并不需要太多的状态码，以下状态码足够用于市面上的网关系统
| 状态码 | 说明 |
|---|---|
| 200 | 客户端向服务请求数据，并且服务找到了对应的数据 |
| 400 | 客户端错误用的。例如:客户端提供了一些错误或不存在的参数 |
| 403 | 无访问权限 |
| 404 | 资源不存在 |
| 500 | 服务器错误 |
响应格式
成功
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: no-cache
{
"id": 568590,
"name": "Team 8"
"acronym": "T8"
}失败
HTTP/1.1 400 Bad Request
Content-Type: application/json
Cache-Control: no-cache
{
"error": "Parameter Error",
"message": "Provided attributes do not exist for this resource."
}
message主要作为错误补充或描述，如果为空就不返回，例如路由不存在时不需要说明错误
HTTP/1.1 400 Bad Request
Content-Type: application/json
Cache-Control: no-cache
{
"error": "Route not found"
}
讨论