#REST API データソース

#はじめに

このプラグインを使うと、REST API からのデータをシームレスに連携できます。

#インストール

このプラグインは商用プラグインのため、プラグインマネージャーからアップロードして有効化する必要があります。

#REST API データソースの追加

プラグインを有効化した後、データソース管理の「新規追加」ドロップダウンメニューから「REST API」を選択して、REST API データソースを追加できます。

REST API データソースを設定します。

#コレクションの追加

NocoBase では、RESTful なリソースはコレクションにマッピングされます。例えば、Users リソースの場合です。

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

これらのAPIエンドポイントは、NocoBase API では次のようにマッピングされます。

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

NocoBase API の設計仕様に関する詳細なガイドについては、API ドキュメントを参照してください。

詳細については、「NocoBase API - Core」の章をご確認ください。

REST API データソースのコレクション設定は以下の通りです。

#List

リソースのリストを表示するためのインターフェースをマッピングします。

#Get

リソースの詳細を表示するためのインターフェースをマッピングします。

#Create

リソースを作成するためのインターフェースをマッピングします。

#Update

リソースを更新するためのインターフェースをマッピングします。

#Destroy

リソースを削除するためのインターフェースをマッピングします。

List と Get の両インターフェースは、必須で設定する必要があります。

#API のデバッグ

#リクエストパラメータの連携

例: List インターフェースにページネーションパラメータを設定します。（もしサードパーティAPIがページネーションをネイティブでサポートしていない場合、NocoBase は取得したリストデータに基づいてページネーションを行います。）

インターフェースに追加された変数のみが有効になることにご注意ください。

「Try it out」をクリックしてデバッグし、レスポンス結果を確認できます。

#レスポンス形式の変換

サードパーティAPIのレスポンス形式は NocoBase の標準ではない場合があり、フロントエンドで正しく表示するためには変換が必要です。

サードパーティAPIのレスポンス形式に基づいて変換ルールを調整し、NocoBase の出力標準に準拠するようにします。

デバッグプロセスの説明

#変数

REST API データソースは、API 連携のために3種類の変数を提供しています。

• データソースのカスタム変数
• NocoBase リクエスト変数
• サードパーティレスポンス変数

#データソースのカスタム変数

#NocoBase リクエスト

• Params：URL クエリパラメータ（Search Params）です。各インターフェースによって異なります。
• Headers：リクエストヘッダーです。主に NocoBase 独自の X- 情報を提供します。
• Body：リクエストボディです。
• Token：現在の NocoBase リクエストの API トークンです。

#サードパーティレスポンス

現在、レスポンスボディのみが提供されています。

各インターフェース連携時に利用可能な変数は以下の通りです。

#List

#Get

#Create

#Update

#Destroy

#フィールドの設定

適応されたリソースの CRUD インターフェースデータから、フィールドのメタデータ（Fields）をコレクションのフィールドとして抽出します。

フィールドのメタデータを抽出します。

フィールドとプレビュー。

フィールドを編集します（他のデータソースと同様の方法です）。

#REST API データソースブロックの追加

コレクションの設定が完了したら、インターフェースにブロックを追加できます。