APIScript

Version 25.3.9411


APIScript

Version 25.3.9411


CData には、APIScript と呼ばれる独自の設定言語があり、API リソースのスキーマをマークアップするために使用できます。APIScript は、REST API を介して基底のデータソースとの複雑なやり取りを隠します。管理コンソールのウィザードを使って、REST API を通じてデータベースに接続を行うスキーマを生成することができます。

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

キーワード、アトリビュート、アイテム、オペレーション、およびフィードを使ってスクリプトを記述します:

  • 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:アイテムをインプットとして受け入れ、フィードをアウトプットとして生成するメソッドの一般名。
  • Keywordapi:set のようなAPIScript ステートメント。

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

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