JSON API: 显示链接的正确方式?

JSON API: Correct way to show links?

我用 Laravel 和 Laravel 5 JSON API Transformer package 做了一个 JSON API,它被列在 jsonapi.org

现在,一切都按预期工作,我的 api 的示例响应就像(顺便说一句,验证失败所以我看了一下 jsonapi 规范):

{
  "data": [
    {
      "type": "inventory",
      "id": "INV0001",
      "attributes": {
        "inv_inventory_id": "INV0001",
        "inv_owner_company_id": 1,
        "inv_owner_department_id": 1,
        "inv_user_department_id": 1,
        "inv_user_worker_id": 1,
        "title": "Schreibtisch"
      },
      "links": {
        "self": {
          "href": "http://127.0.0.1:8000/api/v2/inventory/INV0001"
        },
        "user": {
          "href": "http://127.0.0.1:8000/api/v2/worker/1"
        },
        "owner_dept": {
          "href": "http://127.0.0.1:8000/api/v2/department/1"
        },
        "owner_comp": {
          "href": "http://127.0.0.1:8000/api/v2/company/1"
        }
      },
      "relationships": {
        "worker": {
          "data": {
            "type": "worker",
            "id": "1"
          }
        },
        "department": {
          "data": {
            "type": "department",
            "id": "1"
          }
        },
        "company": {
          "data": {
            "type": "company",
            "id": "1"
          }
        }
      }
    }
  ],
  "included": [
    {
      "type": "worker",
      "id": "1",
      "attributes": {
        "wrk_forename": "Moritz",
        "wrk_surname": "ASDF",
        "wrk_department_id": 2,
        "wrk_homeoffice": true,
        "wrk_room_id": 1
      },
      "links": {
        "self": {
          "href": "http://127.0.0.1:8000/api/v2/worker/1"
        },
        "hardware": {
          "href": "http://127.0.0.1:8000/api/v2/worker/1/hardware"
        },
        "software": {
          "href": "http://127.0.0.1:8000/api/v2/worker/1/software"
        },
        "inventory": {
          "href": "http://127.0.0.1:8000/api/v2/worker/1/inventory"
        },
        "accessory": {
          "href": "http://127.0.0.1:8000/api/v2/worker/1/accessory"
        }
      }
    },
    {
      "type": "department",
      "id": "1",
      "attributes": {
        "department": "Entwicklung",
        "dept_floor_id": 3
      },
      "links": {
        "self": {
          "href": "http://127.0.0.1:8000/api/v2/department/1"
        },
        "floor": {
          "href": "http://127.0.0.1:8000/api/v2/floor/3"
        },
        "hardware": {
          "href": "http://127.0.0.1:8000/api/v2/department/1/hardware"
        },
        "software": {
          "href": "http://127.0.0.1:8000/api/v2/department/1/software"
        },
        "inventory": {
          "href": "http://127.0.0.1:8000/api/v2/department/1/inventory"
        },
        "accessory": {
          "href": "http://127.0.0.1:8000/api/v2/department/1/accessory"
        }
      }
    },
    {
      "type": "company",
      "id": "1",
      "attributes": {
        "company": "GermanPersonnel",
        "com_building_id": 1
      },
      "links": {
        "self": {
          "href": "http://127.0.0.1:8000/api/v2/company/1"
        }
      }
    }
  ],
  "links": {
    "self": {
      "url": "http://127.0.0.1:8000/api/v2/inventory?page[number]=1&page[size]=10"
    },
    "first": {
      "url": "http://127.0.0.1:8000/api/v2/inventory?page[number]=1&page[size]=10"
    },
    "last": {
      "url": "http://127.0.0.1:8000/api/v2/inventory?page[number]=1&page[size]=10"
    }
  },
  "meta": {
    "page": {
      "total": 1,
      "last": 1,
      "number": 1,
      "size": 10
    }
  },
  "jsonapi": {
    "version": "1.0"
  }
}

但根据 jsonapi.org 上的规范,link 应该看起来像

  "links": {
    "self": "http://127.0.0.1:8000/api/v2/inventory/INV0001"
   },

我的问题是:

在我的示例输出中将 link 显示为对象是否合法 "href"?我很困惑,因为我使用的包是 在 jsonapi.org 上列出,但似乎不符合规格。

顺便说一句:我的英语可能有点混乱,但我希望我能尽可能详细地描述我的问题

这实际上是有效的 JSON API 输出基于规范,

http://jsonapi.org/format/#document-links

Where specified, a links member can be used to represent links. The value of each links member MUST be an object (a “links object”).

规范中的有效样本

"links": {
  "related": {
    "href": "http://example.com/articles/1/comments",
    "meta": {
      "count": 10
    }
  }
}

links 对象的每个成员都是一个“link”。 link 必须表示为:

  • 包含 link 的 URL 的字符串。
  • 一个对象(“link 对象”),它可以包含以下成员:
    • href:包含link的URL.
    • 的字符串
    • meta:包含 non-standard meta-information 关于 link.
    • 的元对象

因此,您的输出实际上是有效的。