仕様書APIの基礎知識

アプリケーションメニューやREST APIで商品仕様を管理することができます。 headless-commerce-admin-catalog サービスを呼び出し、仕様を作成・管理する。

仕様を追加する

新しいLiferay DXPインスタンスを起動し、以下を実行します。

docker run -it -m 8g -p 8080:8080 liferay/dxp:2024.q2.11。

メールアドレス [e-mail] とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。

Liferayが起動したら、

1. Specification API Basics をダウンロードし、解凍してください。

   curl https://resources.learn.liferay.com/commerce/latest/en/product-management/developer-guide/liferay-u9x9.zip -O
   

   unzip liferay-u9x9.zip
   

2. 仕様はインスタンスにスコープされ、各仕様は一意の キー と タイトルを指定する必要がある。

   cURLスクリプトを使用して、新しい仕様を追加します。 コマンドラインで、 curlフォルダに移動します。 Specification_POST_ToInstance.sh スクリプトを実行する。

   ./Specification_POST_ToInstance.sh
   

   JSONレスポンスは、新しい仕様が追加されたことを示します：

   {
      "description" : { },
      "facetable" : false,
      "id" : 45936,
      "key" : "foo",
      "title" : {
         "en_US" : "Foo"
      }
   }
   

3. 仕様追加を確認するには、 Global Menu() を開き、 Commerce → Specifications に移動してください。 新しい仕様が「仕様ラベル」タブに表示されます。

   

   note

   現在、APIでは仕様グループへの仕様ラベルの追加や仕様グループの作成はできません。 代わりにSpecifications UIを使用する必要があります。 グローバルメニュー( ）を開き、Commerce → Specifications に移動します。 詳しくは、 仕様グループ を参照してください。

4. または、Javaクライアントを使用してRESTサービスを呼び出します。 javaフォルダに移動し、ソースファイルをコンパイルします。

   javac -classpath .:* *.java
   

5. Specification_POST_ToInstance クラスを実行します。

   java -classpath .:* Specification_POST_ToInstance
   

cURLコマンドの検証

Specification_POST_ToInstance.sh スクリプトは、cURL コマンドで REST サービスを呼び出します。

curl \
	"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/specifications" \
	--data-raw '
		{
			"key": "foo",
			"title": {
				"en_US": "Foo"
			}
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "[e-mail]:learn"

コマンドの引数は次のとおりです。

引数	説明
-H "Content-Type: application/json"	リクエストボディの形式をJSONに設定します。
-X POST	指定されたエンドポイントで呼び出す HTTP メソッドを設定します。
"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/specifications"	RESTサービスのエンドポイントを指定します。
-d "{\"key\": \"foo\", \"title\": {\"en_US\": \"Foo\"}}"	投稿するデータを入力します。
-u "[e-mail]:learn"	基本認証の認証情報を入力します。

note

ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth 2.0を使用する 経由でユーザーを認証する必要があります。 OAuth2を活用したReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証 をご覧ください。

他のcURLコマンドも同様のJSON引数を使用します。

Javaクラスを調べる

Specification_POST_ToInstance.java クラスは、 SpecificationResource サービスを呼び出すことで仕様を追加します。

このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。

行(省略形）	説明
SpecificationResource.Builder builder = ...	SpecificationResource サービスインスタンスを生成するための Builder を取得する。
SpecificationResource specificationResource = builder.authentication(...).build();	基本認証を使用し、 SpecificationResource サービスインスタンスを生成します。
specificationResource.postSpecification(...);	specificationResource.postSpecification メソッドを呼び出し、postにデータを渡します。

このプロジェクトには、依存関係としてcom.liferay.headless.commerce.admin.catalog.client.jar ファイルが含まれています。 すべてのRESTアプリケーションのクライアントJAR依存情報は、インストール先のAPIエクスプローラーで/o/api (例: http://localhost:8080/o/api) から確認できます。

note

mainメソッドのコメントでは、クラスの実行を実演しています。

残りのサンプルJavaクラスは、異なる SpecificationResource のメソッドを呼び出します。

important

サービスの詳細は SpecificationResource を参照ください。

以下は、cURLとJavaを使用して、他の 仕様 RESTサービスを呼び出す例です。

インスタンスから仕様を取得する

cURLやJavaのコマンドで、Liferayインスタンスのすべての仕様をリストアップします。

Specifications_GET_FromInstance.sh

コマンド：

./Specifications_GET_FromInstance.sh

コード：

Specifications_GET_FromInstance.java

コマンド：

java -classpath .:* Specifications_GET_FromInstance

コード：

インスタンスの 仕様 オブジェクトはJSONでフォーマットされています。

フィルタリング、ページ分割、検索、並べ替えの仕様について

このAPIでは、仕様のフィルタリング、ページ分割、検索、並べ替えのためのパラメータも受け付ける。 詳しくは、 getSpecificationsPage メソッドをご覧ください。 クエリでは、以下の 仕様 フィールドを使用して、結果のフィルタリング、検索、ソートを行うことができます：

• キー
• タイトル

フィルタークエリ	説明
key eq 'foo'	指定キーはfooと等しくなければならない。
title eq 'Bar'	仕様タイトルはBarである必要があります。

ソートクエリ	説明
key:desc	キーで降順に並べます。
title:asc	タイトルの昇順で並べます。

詳しくは、 APIクエリパラメータ をご参照ください。

仕様書を入手する

cURL または Java get コマンドで特定の仕様を取得します。 1234 を仕様書のIDに置き換えてください。

tip

Specifications_GET_FromInstance.[java|sh]を使用して、すべての仕様のリストを取得し、特に欲しい仕様の id をメモします。

Specification_GET_ById.sh

コマンド：

./Specification_GET_ById.sh 1234

コード：

Specification_GET_ById.java

コマンド：

java -classpath .:* -DspecificationId=1234 Specification_GET_ById

コード：

仕様書 のフィールドをJSONで記載します。

仕様書の貼り付け

cURLとJava patch コマンドで既存の仕様を更新します。 1234 をお客様の仕様のIDに置き換えてください。

Specification_PATCH_ById.sh

コマンド：

./Specification_PATCH_ById.sh 1234

コード：

Specification_PATCH_ById.java

コマンド：

java -classpath .:* -DspecificationId=1234 Specification_PATCH_ById

コード：

仕様を削除する

cURL と Java delete コマンドで既存の仕様を削除する。 1234 をお客様の仕様のIDに置き換えてください。

Specification_DELETE_ById.sh

コマンド：

./Specification_DELETE_ById.sh 1234

コード：

Specification_DELETE_ById.java

コマンド：

java -classpath .:* -DspecificationId=1234 Specification_DELETE_ById

コード：

RESTサービスの使用 では、 Specification のサービスやスキーマが表示され、各サービスをテストするためのインターフェイスが用意されています。