JSON:API 是一種 API 規(guī)范,定義了客戶端應(yīng)用程序如何從服務(wù)器請求和接收資源。它通過一組結(jié)構(gòu)化的請求和響應(yīng)約定,使開發(fā)人員能夠更輕松地與 API 交互。該規(guī)范的主要優(yōu)點(diǎn)包括:
接下來,我們將詳細(xì)介紹如何在 Drupal 中啟用和使用 JSON:API 模塊。
要開始使用 JSON:API 模塊,請確保您的 Drupal 網(wǎng)站已啟用該模塊。幸運(yùn)的是,該模塊作為核心模塊包含在 Drupal 8 及更高版本中,因此無需額外安裝。

默認(rèn)情況下,Drupal 中的 JSON:API 模塊提供了有限的配置選項,主要集中在指定允許的操作上。

啟用并配置 JSON:API 模塊后,您可以開始測試并與新創(chuàng)建的 API 交互。
以下是一個示例 URL:
http://localhost/jsonapi/node/article
該 URL 將通過 JSON:API 從 文章 節(jié)點(diǎn)資源類型中獲取數(shù)據(jù),并以 JSON:API 規(guī)范格式顯示結(jié)果。您可以通過修改 node/article 部分,與其他資源類型交互或訪問 Drupal 網(wǎng)站中的特定實(shí)體。

您可以使用 Postman 或 cURL 等工具與 JSON:API 進(jìn)行交互。需要注意的是:
確保所有必要的操作已啟用。

啟用 HTTP 基本身份驗證模塊。

為 API 用戶創(chuàng)建一個角色。

為該角色授予必要的權(quán)限。
訪問路徑:/admin/people/permissions/api_user 
在 Postman 中配置授權(quán),使用新創(chuàng)建的賬戶。

添加 Content-Type 標(biāo)頭,值為 application/vnd.api+json。

更新請求正文,例如:
{
"data": {
"type": "node--article",
"attributes": {
"title": "示例文章標(biāo)題",
"body": {
"value": "這是文章的內(nèi)容。",
"format": "plain_text"
}
}
}
}
201,則表示您已成功向 JSON:API 發(fā)出經(jīng)過身份驗證的請求,并創(chuàng)建了一個類型為 article 的節(jié)點(diǎn)。
JSON:API 是一個強(qiáng)大且標(biāo)準(zhǔn)化的 API 規(guī)范,它在 Drupal 8 及更高版本中作為核心模塊的無縫集成,為開發(fā)人員提供了標(biāo)準(zhǔn)化的 API 接口。這不僅減少了對自定義配置的需求,還通過清晰的 URL 模式和 JSON:API 規(guī)范格式,使與 Drupal 網(wǎng)站數(shù)據(jù)的交互變得更加簡單高效。
通過啟用 JSON:API 模塊,您可以輕松實(shí)現(xiàn)數(shù)據(jù)的讀取、創(chuàng)建和更新操作。此外,JSON:API 模塊還支持分頁、排序、文件上傳等高級功能,進(jìn)一步提升了其靈活性和實(shí)用性。
有關(guān)更多詳細(xì)信息,請參考 Drupal JSON:API 模塊文檔,以探索更多功能和使用場景。
原文鏈接: https://drupart.co.uk/blog/introduction-drupal-jsonapi-module