#REST API データソース

#概要

REST API をデータソースとして接続するために使用します。

#インストール

このプラグインは商用プラグインです。詳しい有効化方法については、商用プラグインの有効化ガイドを参照してください。

#REST API ソースの追加

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

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

#Collection の追加

RESTful リソースは NocoBase の Collection に対応します。たとえば、Users リソースです。

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

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 データソースの Collection 設定は次のとおりです。

#List

リソース一覧を取得するインターフェースのマッピングを設定します。

#Get

リソースの詳細を取得するインターフェースのマッピングを設定します。

#Create

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

#Update

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

#Destroy

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

List と Get は必ず設定する必要がある 2 つのインターフェースです。

#API のデバッグ

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

例：List インターフェースにページネーションパラメータを設定します（サードパーティ API 自体がページネーションをサポートしていない場合は、取得した一覧データをページ分割します）。

インターフェースに追加されている変数のみ有効になる点に注意してください。

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

#レスポンス形式の変換

サードパーティ API のレスポンス形式は NocoBase の標準と異なる場合があるため、変換してからでないとフロントエンドに正しく表示できません。

サードパーティ API のレスポンス形式に応じて変換ルールを調整し、NocoBase の出力標準に適合させます。

デバッグ手順の説明

#エラー情報の変換

サードパーティ API でエラーが発生した場合、レスポンスのエラー情報の形式が NocoBase の標準と異なる可能性があるため、変換してからでないとフロントエンドに正しく表示できません。

エラー情報の変換を設定していない場合、デフォルトで HTTP ステータスコードを含むエラー情報に変換されます。

エラー情報の変換を設定すると、NocoBase の出力標準に適合させることができ、フロントエンドにサードパーティ API のエラー情報を正しく表示できます。

#変数

REST API データソースでは、インターフェース連携に使用する 3 種類の変数が提供されています。

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

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

#NocoBase リクエスト

• Params：URL クエリパラメータ（Search Params）。インターフェースごとに Params は異なります。
• Headers：リクエストヘッダー。主に NocoBase 固有の X- 情報を提供します。
• Body：リクエストの Body。
• Token：現在の NocoBase リクエストの API トークン。

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

現在提供されているのはレスポンスの Body のみです。

各インターフェースの連携時に使用できる変数は次のとおりです。

#List

#Get

#Create

#Update

#Destroy

#フィールドの設定

接続先リソースに対応する CRUD インターフェースのデータから、フィールドのメタデータ（Fields）を抽出して Collection のフィールドとして使用します。

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

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

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

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

Collection の設定が完了したら、画面にブロックを追加できます。