一般API情報の定義 - Cloud

Talend Cloud API Designerユーザーガイド
Version
Cloud
Language
日本語
Product
Talend Cloud
Module
Talend API Designer
Content
ジョブデザインと開発 > Designing APIs
Last publication date
2024-03-13
APIのバージョンに関する一般的な情報を編集し、メディアの種類、エンドポイント、セキュリティスキームを定義します。

手順

  1. 一般情報ページにアクセスします。
    このページは、APIの作成後に自動的に開きます。左パネルの上部のAPIの名前をクリックして開くこともできます。
  2. [GENERAL] (一般)セクションの左側にある鉛筆アイコンをクリックし、APIのバージョン、説明、連絡先とライセンス情報、利用規約を編集します。
    注: APIの名前はTalend Cloud API Designerホームページで変更できます。詳細は、API名の変更をご覧ください。
    Petstore APIの[一般]セクション。
  3. [MEDIA TYPES] (メディアタイプ)セクションを編集して、メディアタイプを追加または削除します。
    このセクションで定義されているメディアタイプはグローバルで、APIバージョン全体に適用されます。これらは、オペレーションレベルで定義することもできます。
  4. エンドポイントを[ENDPOINTS] (エンドポイント)セクションに追加します。
    このセクションで定義されているエンドポイントはグローバルで、APIバージョン全体に適用されます。これらが定義されると、エンドポイントは、有効な場合は、左パネルの上部のAPIの名前の下、モックエンドポイントに表示されます。

    公開済みエンドポイントはライブドキュメンテーションおよびポータルに表示されます。Talend Cloud API TesterでAPIを試す時にも、最初の公開済みエンドポイントが使用されます。詳細は、Talend Cloud API TesterでのAPIの試行をご覧ください。公開されていないエンドポイントはTalend Cloud API Designerにのみ表示されます。

    注: 複数のエンドポイントがある場合、Talend Cloud API TesterでAPIを試した時に、リストの最初のものがデフォルトで使用されます。リストのエンドポイントを移動するには、URLの左側のバーをクリックし、上下にドラッグします。
    Petstore APIの[エンドポイント]セクション。
  5. [GLOBAL SECURITY] (グローバルセキュリティ)および[SECURITY SCHEMES] (セキュリティスキーム)セクションで、APIのセキュリティを定義します。
    このセクションで定義されているセキュリティはグローバルで、APIバージョン全体に適用されます。これは、リソースレベルおよびオペレーションレベルで定義することもできます。
  6. [Save] (保存)をクリックします。