一尘不染

标准JSON API响应格式?

json

是否存在用于构造来自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!"
  }
}

阅读 289

收藏
2020-07-27

共1个答案

一尘不染

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

  1. JSON API -JSON API还涵盖创建和更新资源,而不仅仅是响应。
  2. JSend-简单,可能已经在做。
  3. OData JSON协议 -非常复杂。
  4. HAL - OData的一样,但目标是成为HATEOAS等。

还有JSON API描述格式:

2020-07-27