1. 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 の探索を可能にするツールです。

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

テストを設定する

  1. Swagger で、ページ上部のボックスに、次のコードに示されているように、インスタンスのベース URL https://xxxx.stylelabs.com に OpenAPI バージョン 3 の `/openapi/v3/ とドメインの識別子を付加して入力します。

    https://xxxx.stylelabs.com/openapi/v3/DemoDomain

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

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

API トークンの生成

Sitecore Content Hub で API トークンを生成するには:

  1. メニュー バーで、[管理] 管理アイコン をクリックします。

  2. [管理] ページで、[ユーザー] をクリックします。

  3. [ユーザー] ページで、目的のユーザーの横にある [API トークン] をクリックします。

  4. [新規作成] をクリックします。

  5. [トークンのコピー] をクリックし、[API トークン] ダイアログ ボックスで、[トークンのコピー] をクリックします。

  6. [Swagger Petstore] に戻って、[承認] をクリックします。

  7. コピーした API トークンを [X-Auth-Token (apiKey)] ボックスに貼り付け、[承認] をクリックし、[閉じる] をクリックします。

アセット ID を取得する

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

  1. Sitecore Content Hub メニュー バーの [アセット] をクリックします。

  2. アセットを選択し、その詳細ページに移動します。

  3. [アセット] ページで、アセットを選択し、[アセットの詳細] ページで、URL の末尾に表示されているアセット ID をコピーします。

    [システム] タブで [システムのプロパティ] にある [ID] フィールドでアセット ID を見つけることもできます。

  4. [Swagger Petstore] に戻って、[試してみる] をクリックします。

  5. "entityId" フィールドに、アセット ID を貼り付けます。

    テストを実行する

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

  • Swaggerで、[実行] をクリックします。

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

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