Change API Settings

既存のAPIの設定を変更して、コアの詳細、仕様ソース、ラベル、およびAPIのセキュリティ設定を更新できます。

グリッドビューを使用している場合は、三点リーダーメニューをクリックしてアクション項目を開き、次に編集ボタン（鉛筆アイコン）をクリックしてAPI詳細フォームを開きます。

リストビューを使用している場合は、アクション列に移動し、編集ボタン（鉛筆アイコン）をクリックしてAPI詳細フォームを開きます。

編集ボタンをクリックすると、API詳細の編集フォームが開きます。必要に応じて変更を入力してください。

• Backend Name: (必須フィールド) APIのユーザーフレンドリーな表示名（例: PetstoreV3）。

• Backend System Name: (自動入力フィールド) APIの一意の内部識別子（例: petstorev3）。この名前は通常、システム参照で使用され、文字制限がある場合があります。

• Version: (必須フィールド) APIのバージョン番号（例: v1.0.0）。セマンティックバージョニングの慣行に従うことをお勧めします。

• Domain: (必須フィールド) APIがホストされている基本ドメイン（例: https://petstore3.swagger.io/api/v3）。

• BasePath: (必須フィールド) ドメインに追加されて、すべてのエンドポイントの完全な基本URLを形成するサブパス（例: /）。

• Open API Specification: (必須フィールド) APIの定義文書を提供してください。この文書はすべてのエンドポイントと操作を説明します。この定義のソースを3つの方法のいずれかで指定する必要があります：

  • From URL: OpenAPI定義ファイルへの直接ウェブリンクを提供してください（例: .jsonまたは.yamlファイル）。

• Paste JSON: OpenAPI JSON定義の生の内容をテキストフィールドに直接貼り付けます。

• Upload File: ローカルコンピュータからOpenAPI定義ファイルをアップロードします。

• Description: （必須フィールド）APIの目的と機能についての詳細で人間が読みやすい説明を提供するためのテキストフィールドです。この情報はAPI概要画面に表示され、他のユーザーがAPIの使用方法を理解するのに役立ちます。

• Authentication Type: （必須フィールド）クライアントがAPIにアクセスするために必要なセキュリティメソッドを選択します。

  • Basic: 認証のためにユーザー名とパスワードが必要です。
  • Bearer: Authorizationヘッダーにベアラートークン（JWTなど）が必要です。
  • API Key: 通常、リクエストヘッダーまたはクエリパラメータに送信される特定のAPIキーが必要です。
  • None: APIは公開されており、アクセスに認証情報は必要ありません。

• Label: このセクションでは、APIを整理、フィルタリング、またはカスタムメタデータを追加するために使用されるキーと値のペアであるタグを管理できます。

  • ラベルを追加: プラス（+）アイコンをクリックしてラベルの新しい行を追加します。
  • キー / 値: 各ラベルには、キー（識別子、例: 環境）と値（データ、例: デモ）の両方が必要です。エラーメッセージに示されているように、ラベル行が追加されると両方のフィールドが必須となります。
  • ラベルを削除: ゴミ箱アイコンをクリックして対応するラベル行を削除します。 入力した情報を確認した後、Save ボタンをクリックして新しい設定を API に適用します。この画面で行ったすべての変更を破棄したい場合は、Cancel ボタンをクリックしてフォームを閉じてください。