小编Tyl*_*ess的帖子

我的 API 是否应该将 JSON 数据嵌套在父对象中?

今天我被称为“不专业”,因为我没有将 JSON 响应嵌套在父对象中。

GET /users/{id}回应如下:

{
    "username":"atr217",
    "age":35,
    ...
}
Run Code Online (Sandbox Code Playgroud)

他们期望的是这样的:

{
    "user":{
        "username":"atr217",
        "age":35,
        ...
    }
}
Run Code Online (Sandbox Code Playgroud)

或者也许是这样的:

{
    "status":200,
    "message":"OK"
    "data":{
        "username":"atr217",
        "age":35,
        ...
    }
}
Run Code Online (Sandbox Code Playgroud)

我见过两种方式都这样做。将数据包装在父级中是最佳实践吗?如果是这样,为什么?父级中还有什么?

我正在使用 SwaggerHub 和 OpenAPI 3,如果这很重要的话。

api rest json swagger openapi

5
推荐指数
1
解决办法
1869
查看次数

标签 统计

api ×1

json ×1

openapi ×1

rest ×1

swagger ×1