一般API情報の定義

APIのバージョンに関する一般的な情報を編集し、メディアの種類、サーバーURL、セキュリティスキームを定義します。

手順

APIの一般情報ページにアクセスします。
このページは、APIの作成後に自動的に開きます。左パネルの上部のAPIの名前をクリックして開くこともできます。
[General] (一般)セクションで、APIのバージョン、説明、連絡先とライセンス情報、利用規約を編集します。

情報メモ注: APIの名前はTalend Cloud API Designerホームページで変更できます。詳細については、APIの名前を変更をご覧ください。
[Media types] (メディアタイプ)セクションを編集して、メディアタイプを追加または削除します。
このセクションで定義されているメディアタイプはグローバルで、APIバージョン全体に適用されます。これらは、オペレーションレベルで定義することもできます。
[Server URLs] (サーバーURL)セクションに、サーバーのURLを追加します。
このセクションで定義されているサーバーURLはグローバルで、APIバージョン全体に適用されます。これらが定義されると、サーバーURLは、有効な場合は、左パネルの上部のAPIの名前の下、モックエンドポイントに表示されます。
公開済みサーバーURLはライブドキュメンテーションおよびポータルに表示されます。Talend Cloud API TesterでAPIを試用する際にも、最初に公開されたサーバーURLが使用されます。詳細は、Talend Cloud APIテスターでAPIを試すをご覧ください。公開されていないサーバーURLはTalend Cloud API Designerにのみ表示されます。

情報メモ注: 複数のサーバーURLがある場合、Talend Cloud API TesterでAPIを試した時に、リストの最初のものがデフォルトで使用されます。
[Global security] (グローバルセキュリティ)および[Security schemes] (セキュリティスキーム)セクションで、APIのセキュリティを定義します。
このセクションで定義されているセキュリティはグローバルで、APIバージョン全体に適用されます。これは、リソースレベルおよびオペレーションレベルで定義することもできます。

このページは役に立ちましたか?

このページまたはコンテンツにタイポ、ステップの省略、技術的エラーなどの問題が見つかった場合はお知らせください。

こちらにフィードバックをお寄せください