是否存在从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!"
}
}
建议的基本框架看起来不错,但定义的错误对象太有限。人们通常不能用一个值来表达问题,而是需要一系列问题和原因。
我做了一点研究,发现返回错误(异常)最常见的格式是以下形式的结构:
{
"success": false,
"error": {
"code": "400",
"message": "main error message here",
"target": "approx what the error came from",
"details": [
{
"code": "23-098a",
"message": "Disk drive has frozen up again. It needs to be replaced",
"target": "not sure what the target is"
}
],
"innererror": {
"trace": [ ... ],
"context": [ ... ]
}
}
}
这是OASIS数据标准OASIS OData提出的格式,似乎是最标准的选项,但目前任何标准的采用率似乎都不高。此格式与JSON-RPC规范一致。
您可以在以下位置找到实现此功能的完整开源库:Mendocino JSON Utilities。该库支持JSON对象以及异常。
详细信息在我关于JSON REST API中的错误处理的博客文章中讨论
我不会傲慢地宣称这是一个标准,所以我会使用“我更喜欢”的形式。
我更喜欢简洁的响应(当请求/articles列表时,我需要一个JSON文章数组)。
在我的设计中,我使用HTTP进行状态报告,200只返回有效负载。
400返回请求出错的消息:
{"message" : "Missing parameter: 'param'"}
如果模型/控制器/URI不存在,则返回404
如果我这边的处理出现错误,我会返回501并返回消息:
{"message" : "Could not connect to data store."}
从我所看到的情况来看,相当多的REST框架都是这样的。
理论基础:
JSON应该是一种有效载荷格式,而不是会话协议。冗长的会话式有效负载的整个概念来自XML/SOAP世界,以及导致这些臃肿设计的各种错误选择。在我们意识到所有这些都是一个令人头疼的问题之后,REST/JSON的全部目的就是KISS,并遵守HTTP。我不认为JSend中有任何远程标准,尤其是其中更冗长的部分。XHR将对HTTP响应做出反应,如果您对AJAX使用jQuery(像大多数人一样),您可以使用try/catch和done()/fail()回调来捕获错误。我看不出用JSON封装状态报告有多有用。
假设您的问题是关于REST Web服务设计,更准确地说是关于成功/错误。
我认为有三种不同类型的设计。
仅使用HTTP状态代码来指示是否存在错误,并尝试将自己限制在标准状态(通常这就足够了)。优点:它是一个独立于api的标准。缺点:关于真实发生的事情的信息较少。使用HTTP Status+json主体(即使是错误)。为错误定义一个统一的结构(例如:代码、消息、原因、类型等),并将其用于错误,如果成功,则返回预期的json响应。优点:仍然是标准的,因为您使用现有的HTTP状态代码,并返回一个描述错误的json(您提供了有关发生的更多信息)。缺点:输出json会因错误或成功而有所不同。忘记http状态(例如:always status 200),始终使用json,并在响应的根位置添加一个布尔responseValid和一个错误对象(代码、消息等),如果是错误,将填充该对象,否则将填充其他字段(成功)。优点:客户端只处理作为json字符串的响应主体,而忽略状态(?)。缺点:标准越低。
这取决于您的选择:)
根据API的不同,我会选择2或3(对于json rest API,我更喜欢2)。我在设计RESTApi时经历的另一件事是每个资源(url)的文档的重要性:参数、主体、响应、头等+示例。
我还建议您使用jersey(jax-rs实现)+genson(java/json数据绑定库)。您只需在类路径中删除genson+jersey,就会自动支持json。
编辑:
解决方案2是最难实现的,但它的优点是,您可以很好地处理异常,而不仅仅是业务错误,最初的努力更重要,但从长远来看,您会赢得胜利。解决方案3在服务器端和客户端都很容易实现,但它并不是很好,因为您必须将要返回的对象封装在包含responseValid+错误的响应对象中。
我曾经遵循这个标准,在客户端层非常好、简单、干净。
通常,HTTP状态为200,所以这是我在顶部使用的标准检查。我通常使用以下JSON
我还使用API的模板
dynamic response;
try {
// query and what not.
response.payload = new {
data = new {
pagination = new Pagination(),
customer = new Customer(),
notifications = 5
}
}
// again something here if we get here success has to be true
// I follow an exit first strategy, instead of building a pyramid
// of doom.
response.success = true;
}
catch(Exception exception){
response.success = false;
response.message = exception.GetStackTrace();
_logger.Fatal(exception, this.GetFacadeName())
}
return response;
{
"success": boolean,
"message": "some message",
"payload": {
"data" : []
"message": ""
... // put whatever you want to here.
}
}
在客户端层上,我将使用以下内容:
if(response.code != 200) {
// woops something went wrong.
return;
}
if(!response.success){
console.debug ( response.message );
return;
}
// if we are here then success has to be true.
if(response.payload) {
....
}
请注意我是如何提前打破厄运金字塔的。
有点晚了,但这是我对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 }}, // [] ...
});