OpenAPI

ドメインのテスト

Version:

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

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

次の例では、Swagger Petstore を使用して、デモドメインというサンプルドメインをテストします。ドメインは、複数の API 定義にわたって使用されるパラメーター、応答、データモデルなどの仕様とマッピングのライブラリです。ドメインは、固有のビジネスケースと、関連するドメイン仕様をグループ化およびバージョン管理するメカニズムを表します。新しいドメインの作成の詳細については、「ドメイン管理」を参照してください。

[!注] Swagger Petstore は、OpenAPI の探索を可能にするツールです。

この例で使用するデモドメインは次のとおりです。

名前: デモドメイン
有効化: オン
識別子: DemoDomain

仕様:

  [
    {
      "version": 1,
      "status": 0,
      "entity_views": {
        "M.Asset": {
          "identifier": "M.Asset",
          "entity_definition_name": "M.Asset",
          "version": "1.0",
          "public_links": true,
          "languages": [
            "en-US"
          ],
          "properties": [
            "Title",
            "FileName",
            "Description"
          ],
          "system_properties": {
            "id": false,
            "identifier": true,
            "version": true,
            "created_on": {
              "language": "en-US",
              "format": "dddd, MMMM dd, yyyy HH:mm:ss",
              "utc_time_offset": "03:00"
            },
            "modified_on": {
              "language": "en-US"
            },
            "created_by": false,
            "modified_by": false
          },
          "relations": [
            {
              "relation_name": "FinalLifeCycleStatusToAsset",
              "relation_role": 1,
              "view": {
                "identifier": "M.Final.LifeCycle.Status",
                "entity_definition_name": "M.Final.LifeCycle.Status",
                "version": 1,
                "public_links": false,
                "properties": [
                  "StatusValue"
                ],
                "system_properties": {},
                "relations": [],
                "renditions": []
              }
            }
          ],
          "renditions": [
            {
              "rendition_link_name": "preview"
            },
            {
              "rendition_link_name": "thumbnail"
            }
          ]
        }
      }
    }
  ]

ステータス: なし

[!注] Swagger Petstore は、OpenAPI の探索を可能にするツールです。

ドメインをテストするには:

テストを設定する。
API トークンを生成します。
アセット ID を取得します。
テストを実行します。

テストを設定する

Swagger で、ページ上部のボックスに、インスタンスのベース URL https://xxxx.stylelabs.com を入力します。さらに、次に示すように、OpenAPI バージョン 3 の場合は /openapi/v3/ を付加し、続けてドメインの識別子を追加します。

https://xxxx.stylelabs.com/openapi/v3/DemoDomain
[参照] をクリックして、利用可能な仕様を参照します。表示された結果で、GET メソッドを使用して M.Asset エンティティ定義から情報を取得していることがわかります。 entityID が必要です。

呼び出しを成功させるには、次のものが必要です。

認証するための API トークン。
API 呼び出すを実行するためのアセット ID。

API トークンを生成する

Sitecore Content Hub で API トークンを生成するには、以下の手順に従います。

メニューバーで、[管理] をクリックします。
[管理] ページで、[ユーザー] をクリックします。
[ユーザー] ページで、目的のユーザーの横にある API トークンをクリックします。
[新規作成] をクリックします。
[トークンのコピー] をクリックし、API トークンダイアログボックスで、[トークンのコピー] をクリックします。
[Swagger Petstore] に戻って、[承認] をクリックします。
コピーした API トークンを [X-Auth-Token (apiKey)] ボックスに貼り付け、[承認] をクリックし、[閉じる] をクリックします。

アセット ID を取得する

アセット ID を取得するには、次の手順に従います。

Sitecore Content Hub メニューで、[アセット] をクリックします
アセットを選択し、その詳細ページに移動します。
[アセット] ページで、アセットを選択し、[アセットの詳細] ページで、URL の末尾に表示されているアセット ID をコピーします。

[システム] タブで [システムプロパティ] の下にあるアセット ID を見つけることもできます。
[Swagger Petstore] に戻って、[試してみる] をクリックします。
"entityId" フィールドに、アセット ID を貼り付けます。

テストを実行する

要求の成功または失敗を判断するには、[実行] 機能を使用します。テキストを実行するには、次の手順に従います。

Swaggerで、[実行] をクリックします。
サーバーは、要求が成功したことを示すコード 200 を返します。応答本文に、アセットプロパティおよび関連するメタデータが表示されます。

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