[API] Linking and Embedding

https://developer.wordpress.org/rest-api/using-the-rest-api/linking-and-embedding/

API WP REST kết hợp siêu liên kết trong toàn bộ API để cho phép khả năng phát hiện và khả năng duyệt, cũng như nhúng các tài nguyên liên quan với nhau trong một phản hồi. Mặc dù REST API không hoàn toàn tuân theo toàn bộ tiêu chuẩn HAL, nhưng nó thực hiện các thuộc tính ._links và ._embedded từ tiêu chuẩn đó như được mô tả bên dưới.

Links

Các tài nguyên trong chế độ nhúng sẽ chứa một khóa _embedded bổ sung bên cạnh khóa _links chứa các tài nguyên được liên kết. Chỉ các liên kết có tham số nhúng được đặt thành true mới được nhúng.

Thuộc tính _links của đối tượng phản hồi chứa một bản đồ các liên kết đến các tài nguyên API khác, được nhóm theo “mối quan hệ”. Mối quan hệ chỉ định cách tài nguyên được liên kết liên quan đến tài nguyên chính. (Ví dụ bao gồm “tác giả”, mô tả mối quan hệ giữa tài nguyên và tác giả của nó hoặc “wp: term”, mô tả mối quan hệ giữa bài đăng và các thẻ hoặc danh mục của nó.) Mối quan hệ này là một mối quan hệ chuẩn hóa, một mối quan hệ URI (như https://api.w.org/term) hoặc quan hệ URI nhỏ gọn (như wp: term). (Quan hệ URI nhỏ gọn có thể được chuẩn hóa thành quan hệ URI đầy đủ để đảm bảo khả năng tương thích hoàn toàn nếu được yêu cầu.) Điều này tương tự với thẻ HTML hoặc liên kết .

Các liên kết là một đối tượng có chứa thuộc tính href với URL tuyệt đối đến tài nguyên, cũng như các thuộc tính tùy chọn khác. Chúng bao gồm các loại nội dung, thông tin định vị và dữ liệu về các hành động có thể được thực hiện với liên kết.

Đối với phản hồi tập hợp (những phản hồi trả về danh sách các đối tượng thay vì đối tượng cấp cao nhất), mỗi mục chứa các liên kết và phản hồi cấp cao nhất bao gồm các liên kết thông qua tiêu đề Liên kết.

Example Response

A typical single post request (/wp/v2/posts/42):

{
  "id": 42,
  "_links": {
    "collection": [
      {
        "href": "https://example.com/wp-json/wp/v2/posts"
      }
    ],
    "author": [
      {
        "href": "https://example.com/wp-json/wp/v2/users/1",
        "embeddable": true
      }
    ]
  }
}

Embedding

Theo tùy chọn, một số tài nguyên được liên kết có thể được đưa vào phản hồi để giảm số lượng yêu cầu HTTP cần thiết. Các tài nguyên này được "nhúng" vào phản hồi chính.

Nhúng được kích hoạt bằng cách đặt tham số truy vấn _embed theo yêu cầu. Sau đó, điều này sẽ bao gồm các tài nguyên được nhúng trong khóa _embedded bên cạnh khóa _links. Bố cục của đối tượng này phản ánh đối tượng _links, nhưng bao gồm tài nguyên nhúng thay cho các thuộc tính liên kết.

Chỉ các liên kết có cờ nhúng được đặt thành true mới có thể được nhúng và _embed sẽ khiến tất cả các liên kết có thể nhúng được nhúng.

Chỉ các liên kết có cờ nhúng được đặt thành true mới có thể được nhúng và _embed sẽ khiến tất cả các liên kết có thể nhúng được nhúng. Chỉ các quan hệ có chứa các phản hồi nhúng mới được đưa vào _embedded, tuy nhiên, các quan hệ với các liên kết có thể nhúng và không thể thay đổi hỗn hợp sẽ chứa các phản hồi giả cho các liên kết không thể thay đổi để đảm bảo các chỉ mục số khớp với các chỉ mục trong _links.

Khi nhúng phản hồi tập hợp, ví dụ: / wp / v2 / posts? author= 1, tập hợp được nhúng sẽ áp dụng giới hạn phân trang mặc định.