メインコンテンツまでスキップ

View API Settings

API設定を表示するには、Backend Serversページに移動します。必要なAPIを見つけて、APIをクリックして詳細な概要を開きます。

ヒント

検索およびフィルターツールを使用して、必要なAPIを迅速に見つけてください。

概要​

概要タブは、選択したAPIに関する重要な詳細情報を提供します。これには、設定やメタデータが含まれます。

API情報​

このセクションには、APIを特定し説明する一般的で高レベルな情報が含まれています。

  • Version: セマンティックバージョニングに従ったAPIの特定のリリースバージョンを示します（例: v1.0.0）。これにより、時間の経過に伴う更新や変更を追跡できます。
  • Backend System Name: システム内でのAPIのユニークな内部識別子またはコードネーム（例: petstorev3）。
  • Description: APIの目的、基づいている仕様（OpenAPI 3.0など）、設計アプローチ、および目標を説明する詳細な説明。
  • Label: APIを分類、フィルタリング、および整理するために使用されるキーと値のペア。これにより、カスタムメタデータを追加する柔軟な方法が提供されます。APIは、異なる目的のために複数のラベルを持つことができます。

バックエンド情報​

このセクションでは、APIと対話するために必要な技術的エンドポイント情報の詳細を説明します。

  • Backend ID: APIを支える特定のバックエンドサービスを識別するユニークなシステム生成の英数字文字列（例: 68a67d3008c05608c7f1c734）。
  • Domain: APIがホストされている主要なウェブアドレスです。これはすべてのAPI呼び出しのベースURLです（例: https://petstore3.swagger.io/api/v3）。
  • BasePath: ドメインに追加されてAPIエンドポイントの完全なベースURLを作成するパスセグメントです。値が / の場合、エンドポイントはドメインのルートから直接アクセスされることを示します。

認証情報​

このセクションでは、APIにアクセスするためのセキュリティ要件を指定します。

  • Authentication Type: APIを保護するために使用される方法を定義します。たとえば、値は None であり、これはAPIが公開されており、アクセスに認証情報やトークンを必要としないことを意味します。

メタ情報​

このセクションでは、システム内でのAPIのライフサイクルに関する監査および追跡情報を提供します。

  • Date of Creation: APIがシステムに最初に登録された正確な日時です。
  • Constructor: APIを作成した個人またはプロセスのユーザー名またはIDです。
  • Date of Modification: APIの構成が最後に更新された日時を示すタイムスタンプです。
  • Modifier: 最も最近の変更を行った個人またはプロセスのユーザー名またはIDです。

APIプレビュー​

APIプレビュータブは、Swagger UIのようなツールによって提供されるインタラクティブなユーザーインターフェースを提供し、ブラウザから直接APIのエンドポイントを探索およびテストすることを可能にします。

API仕様​

このセクションでは、API仕様の主要な識別詳細を見つけることができます。

  • API Title: APIの公式名称。
  • Version Badges: APIのバージョン番号を示す小さなタグ（例: 1.0.27）と、それが準拠している仕様（例: OAS 3.1はOpenAPI Specification 3.0のためのもの）。
  • Description: APIの人間が読める要約。

API 認証​

このセクションでは、テストリクエストを構成し、認証するための要素を見つけることができます。

  • Servers: API呼び出しのターゲットサーバー環境を選択するためのドロップダウンメニュー。これにより、開発、ステージング、または本番環境など、異なるベースURL間で切り替えることができます。
  • Authorize: 認証情報（APIキーやOAuth2トークンなど）を入力できるダイアログ「利用可能な認証」を開くボタン。この設定が完了すると、これらの認証情報はこのページから行うすべてのテストリクエストに自動的に含まれます。

API エンドポイント​

これはAPIプレビューのコアであり、すべての利用可能な操作がリストされています。

  • Endpoint Groups: エンドポイントは「タグ」に基づいて論理グループに整理されており、通常は特定のリソースに対応します。この例では、すべてのエンドポイントがペットタグの下にグループ化されています。
  • Endpoint Details: 各行は実行可能な単一の操作を表し、以下を含みます：
    • HTTP Method: PUT（更新）、POST（作成）、またはGET（読み取り）などのアクションの種類。
    • Path: エンドポイントの特定のURLパス（例: /pet, /pet/findByStatus）。
  • Description: エンドポイントが何をするのかの簡単な概要です。
    • Authentication Indicator: 鍵のアイコンは、エンドポイントが認証を必要とするかどうかを示します。ロックされていないアイコンはオープンであることを意味し、ロックされたアイコンは、Authorizeボタンを使用して資格情報を提供する必要があることを意味します。

任意のエンドポイント行をクリックすると、必要なパラメータ、リクエストボディの構造、可能なレスポンスを含む詳細情報を表示するために展開でき、さらにはライブAPIコールを実行することもできます：

Schemas​

プレビューページの下部に位置する Schemas セクションは、APIのリクエストとレスポンスで使用されるすべてのデータモデルの構造を定義します。

  • スキーマリスト: このエリアには、Pet, Order, Userなど、定義されたすべてのデータオブジェクトがリストされています。
  • 詳細を表示: 任意のスキーマ名をクリックすると、それを展開できます。これにより、フィールド名（例: id, name）、データ型（integer, string）、および例を含むオブジェクトのプロパティの詳細ビューが表示されます。