是否存在从API构建JSON响应的标准或最佳实践？显然，每个应用程序的数据都是不同的，所以我不太关心，而是“响应样板”，如果你愿意的话。我的意思是：
成功的请求：
{
"success": true,
"payload": {
/* Application-specific data would go here. */
}
}
失败的请求：
{
"success": false,
"payload": {
/* Application-specific data would go here. */
},
"error": {
"code": 123,
"message": "An error occurred!"
}
}
当前回答
对于移动开发人员容易理解的web api的最佳响应。
这是“成功”响应
{
"code":"1",
"msg":"Successfull Transaction",
"value":"",
"data":{
"EmployeeName":"Admin",
"EmployeeID":1
}
}
这是“错误”响应
{
"code": "4",
"msg": "Invalid Username and Password",
"value": "",
"data": {}
}
其他回答
以下是instagram使用的json格式
{
"meta": {
"error_type": "OAuthException",
"code": 400,
"error_message": "..."
}
"data": {
...
},
"pagination": {
"next_url": "...",
"next_max_id": "13872296"
}
}
是的，出现了一些标准（尽管在标准定义上有些自由）：
JSON API-JSON API还包括创建和更新资源，而不仅仅是响应。JSend-简单，可能是您已经在做的事情。OData JSON协议-非常复杂。哈尔-像OData，但目标是像HATEOAS。
还有JSON API描述格式：
大摇大摆JSON模式（swagger使用，但可以单独使用）JSON格式的WADL冲压，冲压HAL，因为理论上HATEOAS是自我描述的。
他们对大型软件巨头（谷歌、脸书、推特、亚马逊等）的rest api响应格式没有达成一致，尽管上面的答案中提供了许多链接，一些人已经尝试将响应格式标准化。
由于API的需求可能不同，很难让每个人都加入并同意某种格式。如果您有数百万用户使用您的API，为什么要更改响应格式？
以下是我对谷歌、推特、亚马逊和互联网上一些帖子的回应格式的看法：
https://github.com/adnan-kamili/rest-api-response-format
交换文件：
https://github.com/adnan-kamili/swagger-sample-template
我将此结构用于REST API：
{
"success": false,
"response": {
"data": [],
"pagination": {}
},
"errors": [
{
"code": 500,
"message": "server 500 Error"
}
]
}
有点晚了，但这是我对HTTP错误响应的看法，我发送代码（通过状态）、通用消息和详细信息（如果我想提供特定端点的详细信息，有些是不言自明的，因此不需要详细信息，但它可以是自定义消息，甚至可以是完整的堆栈跟踪，具体取决于用例）。为了成功，数据属性中的格式、代码、消息和任何数据都是类似的。
ExpressJS响应示例：
// Error
res
.status(422)
.json({
error: {
message: 'missing parameters',
details: `missing ${missingParam}`,
}
});
// or
res
.status(422)
.json({
error: {
message: 'missing parameters',
details: 'expected: {prop1, prop2, prop3',
}
});
// Success
res
.status(200)
.json({
message: 'password updated',
data: {member: { username }}, // [] ...
});
