是否存在从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!"
  }
}

当前回答

JSON-RPC 2.0定义了一种标准的请求和响应格式,在使用REST API之后,它是一股新鲜空气。

其他回答

JSON-RPC 2.0定义了一种标准的请求和响应格式,在使用REST API之后,它是一股新鲜空气。

对于移动开发人员容易理解的web api的最佳响应。

这是“成功”响应

{  
   "code":"1",
   "msg":"Successfull Transaction",
   "value":"",
   "data":{  
      "EmployeeName":"Admin",
      "EmployeeID":1
   }
}

这是“错误”响应

{
    "code": "4",
    "msg": "Invalid Username and Password",
    "value": "",
    "data": {}
}

是的,出现了一些标准(尽管在标准定义上有些自由):

JSON API-JSON API还包括创建和更新资源,而不仅仅是响应。JSend-简单,可能是您已经在做的事情。OData JSON协议-非常复杂。哈尔-像OData,但目标是像HATEOAS。

还有JSON API描述格式:

大摇大摆JSON模式(swagger使用,但可以单独使用)JSON格式的WADL冲压,冲压HAL,因为理论上HATEOAS是自我描述的。

以下是instagram使用的json格式

{
    "meta": {
         "error_type": "OAuthException",
         "code": 400,
         "error_message": "..."
    }
    "data": {
         ...
    },
    "pagination": {
         "next_url": "...",
         "next_max_id": "13872296"
    }
}

我不会傲慢地宣称这是一个标准,所以我会使用“我更喜欢”的形式。

我更喜欢简洁的响应(当请求/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封装状态报告有多有用。