一般API情報の定義

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

APIの一般情報ページにアクセスします。
このページは、APIの作成後に自動的に開きます。左パネルの上部のAPIの名前をクリックして開くこともできます。
[General] (一般)セクションで、APIのバージョン、説明、連絡先とライセンス情報、利用規約を編集します。
情報メモ注: APIの名前はAPI Designerホームページで変更できます。詳細については、「新しいAPIで作業」を参照してください。
[Media types] (メディアタイプ)セクションを編集して、メディアタイプを追加または削除します。
このセクションで定義されているメディアタイプはグローバルで、APIバージョン全体に適用されます。これらは、オペレーションレベルで定義することもできます。
[Server URLs] (サーバーURL)セクションに、サーバーのURLを追加します。
このセクションで定義されているサーバーURLはグローバルで、APIバージョン全体に適用されます。これらが定義されると、サーバーURLは、有効な場合は、左パネルの上部のAPIの名前の下、モックエンドポイントに表示されます。
公開済みサーバーURLはライブドキュメンテーションに表示されます。公開されていないサーバーURLはAPI Designerにのみ表示されます。
[Global security] (グローバルセキュリティ)および[Security schemes] (セキュリティスキーム)セクションで、APIのセキュリティを定義します。
このセクションで定義されているセキュリティはグローバルで、APIバージョン全体に適用されます。これは、リソースレベルおよびオペレーションレベルで定義することもできます。

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

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

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