六月 7, 2018 | 後端和Drupal

Decouple系列:如何使用 JSON-API:安裝、基本使用

要完成Decouple Drupal的作法,API是非常重要的議題,而JSON-API就是產生API的好用模組,不同於核心的rest api,JSON-API安裝後,全部設定預設就完成,並且通過核心權限控制每個api的資料傳輸,搭配一系列的參數使用方式,以達到Decouple的所有需求,本文將帶您了解如何使用 JSON-API

前言

要完成Decouple Drupal的作法,API是非常重要的議題,而JSON-API 則是產生API的一個好用模組,不同於核心的rest api,這個模組裝了以後,全部設定預設就完成,並且可以通過核心的權限來控制每個api的資料傳輸,搭配一系列的參數使用方式,可以達到Decouple的所有需求。 接下來將會一連串來進行這個模組的介紹與使用。

安裝

可以考慮使用 composer進行安裝或直接下載的方式

step1: 使用composer下載

composer require drupal/jsonapi

step2: 啟用模組

drush en jsonapi

檢查是否完成

若您安裝完畢之後,會發現後台沒有任何可以設定的地方

這個使用請輸入以下網址【http://yourdomain/jsonapi】

應該就可以看到基本的API路徑畫面囉

以下是我測試範例

基本練習:取得所有Article文章:GET 方法

在瀏覽器上輸入以下網址,就可以看到所有的Article文章了

http://yourdomain/jsonapi/node/article

以下擷取我的測試環境

看到上面的畫面就代表已經安裝完畢囉,恭喜 :)

結論

由於最近在開發Decouple的專案,因此會需要很多前後端分離的技術。原本使用的是核心的Rest API搭配Views來進行API製作,但覺得稍嫌麻煩(雖然已經很方便了),但看到JSON API的模組寫到將會是最輕量化的選擇,而且有著很棒很方便的彈性,我想這個是我們所需要的,接下來就開始撰寫一系列這個模組的相關文章與應用,希望能夠分享給大家。