API スクリプト

Version 23.0.8844


API スクリプト

Version 23.0.8844


CData は、API Script と呼ばれる独自のコンフィギュレーション言語を持ち、お客様のAPI のリソースのためのスキーマをマークアップするために使うことができます。API Script はREST API 経由で元となるデータソースとのデータ連携を容易にします。管理コンソールのウィザードを使って、REST API を通じてデータベースに接続を行うスキーマを作成することができます。

API Script は、データアクセスおよびプロセッシングのあらゆる側面の管理を可能にするハイレベルなプログラミング言語です。スキーマはAPI Script エンジンにより変換されたスクリプトです。

スクリプトを書く際には、キーワード、アトリビュート、アイテム、オペレーション、およびフィードを使います。

  • Attribute:name-value ペアのname 部分で、attribute=”address”, value=”123 Pleasant Lane” のように使われます。
  • Item:Attribute-value ペアの関連するグループで、インプットとアウトプットを説明します。次に例を示します。

    Attribute="name" value="Bob"
    Attribute="address" value="123 Pleasant Lane"
    Attribute="phone" value="123-4567"
    
  • Feed:アイテムのリスト。例えば、アドレスと電話番号を含む顧客のリストなど。
  • Operation:アイテムをインプットとして受け、フィードをアウトプットとして生成するメソッドの一般名。
  • Keyword:api:set のようなAPI Script ステートメント。

API Script は多様なキーワードを持ち、次のようなことが可能です:

  • API リソースの動作を説明および検証する。
  • 実行フローを管理するためにIf/else 構文やcase 構文などのハイレベルなプログラミング構成を使う。
  • オペレーションを呼び出し、カスタムオペレーションを定義する。
  • アイテム、オペレーションのインプット、フィード、オペレーションの結果を作成し、変更する。
  • アイテムの反復によりオペレーション呼び出しからの結果フィードを処理する。