Option API の基本
オプションテンプレート は、アプリケーションメニューやREST APIで管理することができます。 headless-commerce-admin-catalog サービスを呼び出して、オプションを作成・管理します。
オプションの追加
新しいLiferay DXPインスタンスを起動し、以下を実行します。
docker run -it -m 8g -p 8080:8080 liferay/dxp:7.4.13-u75。
メールアドレス [email protected] とパスワード test を使用して、http://localhost:8080でLiferayにサインインしてください。 プロンプトが表示されたら、パスワードを learn に変更します。
Liferayが起動したら、
Option API Basics をダウンロードして解凍する。
curl https://resources.learn.liferay.com/commmerce/latest/en/product-management/developer-guide/liferay-d3g5.zip -O
unzip liferay-d3g5.zip
オプションはインスタンスにスコープされ、各オプションは一意の
キー
を指定する必要があります。cURLスクリプトを使用して、新しいオプションを追加してください。 コマンドラインで、
curl
フォルダに移動します。Option_POST_ToInstance.sh
スクリプトを実行する。./Option_POST_ToInstance.sh
JSONレスポンスは、新しいオプションが追加されたことを示します。
{ "actions" : { "get" : { "method" : "GET", "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438" }, "update" : { "method" : "PATCH", "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438" }, "delete" : { "method" : "DELETE", "href" : "http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options/46438" } }, "description" : { }, "externalReferenceCode" : "f73e12cd-feae-9e78-5921-6b65f6b993f6", "facetable" : false, "fieldType" : "select", "id" : 46438, "key" : "foo", "name" : { "en_US" : "Foo" }, "required" : false, "skuContributor" : false }
オプションの追加を確認するには、 Global Menu(
) を開き、 Commerce → Options に移動してください。 新しいオプションが表示されます。
または、Javaクライアントを使用してRESTサービスを呼び出します。
java
フォルダに移動し、ソースファイルをコンパイルします。javac -classpath .:* *.java
Option_POST_ToInstance
クラスを実行します。java -classpath .:* Option_POST_ToInstance
項目タイプ | API値 |
---|---|
テキストボックス | "fieldType": "text" |
一覧から選ぶ | "fieldType": "select" |
ラジオボタン | "fieldType": "radio" |
複数選択 | "fieldType": "checkbox_multiple" |
日付 | "fieldType": "date" |
数値 | "fieldType": "numeric" |
ブール値 | "fieldType": "checkbox" |
cURLコマンドの検証
Option_POST_ToInstance.sh
スクリプトは、cURL コマンドで REST サービスを呼び出します。
curl \
-H "Content-Type: application/json" \
-X POST \
"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" \
-d "{\"fieldType\": \"select\", \"key\": \"foo\", \"name\": {\"en_US\": \"Foo\"}}" \
-u "[email protected]:learn"
ここでは、コマンドの引数を紹介します。
引数 | 説明 |
---|---|
-H "Content-Type: application/json" |
リクエストボディの形式をJSONに設定します。 |
-X POST |
指定されたエンドポイントで呼び出す HTTP メソッドを設定します。 |
"http://localhost:8080/o/headless-commerce-admin-catalog/v1.0/options" |
RESTサービスのエンドポイントを指定します。 |
-d "{\"fieldType\": \"select\", \"key\": \"foo\", \"name\": {\"en_US\": \"Foo\"}}" |
投稿するデータを入力します。 |
-u "[email protected]:learn" |
基本認証の認証情報を入力します。 |
ここでは、デモのために基本的な認証を使用しています。 本番環境では、 OAuth 2.0を使用する 経由でユーザーを認証する必要があります。 OAuth2を活用したReactアプリケーションのサンプルは、 OAuth2によるユーザーの認証 をご覧ください。
他のcURLコマンドも同様のJSON引数を使用しています。
Javaクラスを調べる
Option_POST_ToInstance.java
クラスは、 OptionResource
サービスを呼び出してオプションを追加します。
このクラスは、次の3行のコードのみを使用してRESTサービスを呼び出します。
行(省略形) | 説明 |
---|---|
OptionResource.Builder builder = ... |
OptionResource サービスインスタンスを生成するための Builder を取得する。 |
OptionResource optionResource = builder.authentication(...).build(); |
基本認証を使用し、 OptionResource サービスインスタンスを生成します。 |
optionResource.postOption(...); |
optionResource.postOption メソッドを呼び出し、postにデータを渡します。 |
このプロジェクトには、依存関係としてcom.liferay.headless.commerce.admin.catalog.client.jar
ファイルが含まれています。 すべてのRESTアプリケーションのクライアントJAR依存情報は、インストール先のAPIエクスプローラーで/o/api
(例: http://localhost:8080/o/api) から確認できます。
main
メソッドのコメントでは、クラスの実行を実演しています。
残りの例のJavaクラスは、異なる OptionResource
のメソッドを呼び出します。
サービスの詳細は OptionResource を参照してください。
以下は、cURLとJavaを使用して他の Option
RESTサービスを呼び出す例です。
インスタンスからオプションを取得する
cURLやJavaのコマンドで、Liferayインスタンスの全オプションをリストアップします。
オプション_GET_FromInstance.sh
コマンド:
./Options_GET_FromInstance.sh
コード:
オプション_GET_FromInstance.java
コマンド:
java -classpath .:* Options_GET_FromInstance
コード:
インスタンスの Option
オブジェクトはJSONでフォーマットされています。
フィルタリング、ページ分割、検索、並べ替えのオプション
このAPIは、オプションのフィルタリング、ページ分割、検索、並べ替えのためのパラメータも受け付けます。 詳しくは、 getOptionsPage
メソッドをご覧ください。 クエリでは、以下の Option
フィールドを使用して、結果のフィルタリング、検索、およびソートを行うことができます:
- フィールドタイプ
- キー
- name
フィルタークエリ | 説明 |
---|---|
name eq 'Able' |
オプション名はAbleと等しくなければならない。 |
fieldType eq 'select' |
オプションの種類は必ず選択すること。 |
ソートクエリ | 説明 |
---|---|
key:desc |
キーで降順に並べます。 |
name:desc |
名前の降順で並べます。 |
詳しくは、 APIクエリパラメータ をご参照ください。
オプションの取得
cURL または Java get
コマンドで特定のオプションを取得します。 1234
をオプションのIDに置き換えてください。
Options_GET_FromInstance.[java|sh]
を使用して、すべてのオプションのリストを取得し、特に欲しいオプションの id
をメモします。
Option_GET_ById.sh
コマンド:
./Option_GET_ById.sh 1234
コード:
Option_GET_ById.java
コマンド:
java -classpath .:* -DoptionId=1234 Option_GET_ById
コード:
Option
のフィールドはJSONで記載されています。
パッチアオプション
cURL と Java patch
コマンドで、既存のオプションを更新します。 1234
をオプションのIDに置き換えてください。
Option_PATCH_ById.sh
コマンド:
./Option_PATCH_ById.sh 1234
コード:
Option_PATCH_ById.java
コマンド:
java -classpath .:* -DoptionId=1234 Option_PATCH_ById
コード:
オプションの削除
cURL と Java delete
コマンドで既存のオプションを削除します。 1234
をオプションのIDに置き換えてください。
Option_DELETE_ById.sh
コマンド:
./Option_DELETE_ById.sh 1234
コード:
Option_DELETE_ById.java
コマンド:
java -classpath .:* -DoptionId=1234 Option_DELETE_ById
コード:
RESTサービスの使用 では、 Option
のサービスとスキーマを表示し、各サービスをテストするためのインターフェイスを備えています。