オペレーションを作成 - Cloud

Talend Cloud API Designerユーザーガイド

Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend API Designer
Content
ジョブデザインと開発 > Designing APIs
Last publication date
2024-03-13
オペレーションとは、リソースに対して実行できるアクションのことです。

手順

  1. 左パネルの右上の+ボタンをクリックします。
    ヒント: 以前に作成したセクションでオペレーションを直接作成する場合は、セクション名の右側の+ボタンをクリックします。リソースを既に作成している場合は、リソースパスの右側の+ボタンをクリックして、このリソースのオペレーションを作成できます。
  2. [Operation] (オペレーション)をクリックするか、または既存のリソースに作成している場合はオペレーションのタイプ(GETなど)をクリックします。
    既存のリソースにオペレーションを作成すると、そのオペレーションのメソッドとパスが自動的に入力されます。
  3. たとえば、[Get list of contacts] (連絡先リストを取得)など、オペレーションの[Name] (名前)を入力します。
  4. [Method] (メソッド) を選択し、必要に応じて[Path] (パス)[Description] (説明)を入力します。
    既存のリソースと一致しないパスを入力すると、新しいリソースが作成されます。
    /contacts/パスで"Get list of contacts"というGETメソッドを作成する例。
  5. 必要に応じて[Tags] (タグ)およびIdを入力します。
  6. API全体とは異なるセキュリティスキームを追加する場合は、[SECURITY] (セキュリティ)の右側の鉛筆アイコンをクリックし、[Customize security for this resource] (このリソースのセキュリティをカスタマイズ)を選択します。
  7. セキュリティスキームを選択します。
    注: セキュリティスキームは、APIの[SECURITY] (セキュリティ)セクションで定義されます。
  8. 必要に応じて、[REQUEST] (リクエスト)[RESPONSES] (レスポンス)のパラメーターを追加します。
    再利用可能なリクエストボディはサポートされません。
    注: Talend Studioでは、Content-TypeまたはAccess-Keyのようなダッシュを含むヘッダー名がエラーの原因となることがあります。API定義をインポートして、それをジョブまたはルートで使いたい場合は、これらを使わないことをお勧めします。
  9. [Save] (保存)をクリックします。