1. OpenAPI

ドメイン管理

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

OpenAPI 機能にアクセスするには、[管理] に移動し、[OpenAPI] を選択します。

[OpenAPI] ページには既存のドメインが表示されます。

OpenAPIページからは以下の操作を実行できます:

新しいドメインを作成する

ドメインを作成するには、次の手順に従います。

  1. メニュー バーで、[管理] [管理] アイコン をクリックします。
  2. [管理] ページで、[OpenAPI] をクリックします。
  3. [OpenAPI] ページで、[+ドメイン] をクリックします。
  4. [ドメイン] モーダルに必要な情報を入力します。 フィールドは次のとおりです。

    フィールド必須/任意
    名前文字列新しいドメインの名前必須
    有効トグル スイッチ有効/無効任意
    説明文字列新しいドメインの説明オプション
    識別子文字列新しいドメインの識別子必須
  5. [保存] をクリックします。

新しいドメインを設定する

新しいドメインを設定するには:

  1. [OpenAPI] ページの新しいドメインについては、[詳細を表示] をクリックします。

  2. 新しいドメインの詳細ページで、 をクリックします。

  3. [仕様] セクションに、パラメーター、応答、データ モデルなどの必要なデータ マッピングを入力します。

    [!注意]

    Sitecore Content Hub ドメイン定義の例を確認するには、 ドメイン仕様テンプレートを参照してください。

  4. [状態] ドロップダウン リストで、必要な値を選択します。

    オプションは次のとおりです。

    ステータス説明
    ドラフト既定のステータス
    有効仕様は編集できません
    無効API を介して仕様を取得することはできません
  5. [保存] をクリックします。

既存のドメインを編集する

既存のドメインを編集するには:

  1. [OpenAPI] ページの、編集の対象ドメインで、 をクリックします。

  2. [ドメインの詳細] ページで、 をクリックします。

  3. 編集し、[保存] をクリックします。

ドメインを削除する

ドメインを削除するには:

  1. [OpenAPI] ページの削除対象ドメインで、 をクリックします

  2. [削除] の確認モーダルで [OK] をクリックします。

ドメインを有効または無効にする

ドメインを有効または無効にするには:

  • [OpenAPI ページ] の、有効または無効にするドメインの横にあるトグル スイッチをクリックして、ドメインをオンまたはオフにします。

この記事を改善するための提案がある場合は、 お知らせください!