リージョンAPIの基本

Liferay 7.4 U24+ および GA24+

Liferay の REST API を使ってリージョンを作成・管理します。

リージョンの追加

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

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

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

次に、以下の手順に従います。

Regions API Basics をダウンロードして解凍する。

curl https://resources.learn.liferay.com/dxp/latest/en/users-and-permissions/developer-guide/liferay-r2p3.zip -O

unzip liferay-r2p3.zip

国に新しい地域を追加するには、cURLスクリプトを使用します。コマンドラインで curl フォルダに移動します。 Region_POST_ToCountry.shスクリプトを実行する。
```
./Region_POST_ToCountry.sh 1234
```
1234を国のIDに置き換える。 Get Countries from Instance を使ってIDのリストを取得する。

JSON レスポンスは、新しいリージョンが追加されたことを示す：
```
{
  "active" : true,
  "countryId" : 43501,
  "id" : 43503,
  "name" : "Foo",
  "position" : 0.0,
  "regionCode" : "ABL",
  "title_i18n" : { }
}
```
RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curlフォルダからjava フォルダに移動します。ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```

Region_POST_ToCountry.javaクラスを実行する：

java -classpath .:* -DcountryId=1234 Region_POST_ToCountry

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/countries/${1}/regions" \
	--data-raw '
		{
			"name": "Foo",
			"regionCode": "ABL"
		}' \
	--header "Content-Type: application/json" \
	--request "POST" \
	--user "test@liferay.com:learn"

ここでは、コマンドの引数を紹介します。

引数	説明
`-H "Content-Type: application/json"`	リクエストボディのフォーマットがJSONであることを示します。
`-X POST`	指定されたエンドポイントで起動するHTTPメソッド
`"http://localhost:8080/o/headless-admin-address/v1.0/countries/${1}/regions"`	RESTサービスのエンドポイント
`-d "{"name": "Foo", "regionCode": "ABL"}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

note

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

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

Javaクラスを調べる

Region_POST_ToCountry.javaクラスは、Region関連サービスを呼び出して地域を追加する。

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Region region = regionResource.postCountryRegion(
		Long.valueOf(System.getProperty("countryId")),
		new Region() {
			{
				name = "Foo";
				regionCode = "ABL";
			}
		});

	System.out.println(region);
}

このクラスは、わずか3行のコードでRESTサービスを呼び出します。

行（省略形）	説明
`RegionResource.Builder builder = ...`	`RegionResource`サービスインスタンスを生成するための`Builder` を取得する。
`RegionResource regionResource = builder.authentication(...).build();`	基本認証を指定し、`RegionResource` サービスインスタンスを生成する。
`Region region = regionResource.postRegion(...);`	`regionResource.postRegion`メソッドを呼び出し、データをpostに渡す。

このプロジェクトには com.liferay.headless.admin.address.client.jar ファイルが依存関係として含まれていることに注意してください。すべての REST アプリケーションのクライアント JAR 依存情報は、インストールの API エクスプローラーの /o/api にある。

note

mainメソッドのコメントは、クラスの実行を示している。

他のJavaクラスの例もこれと似ているが、異なる RegionResource メソッドを呼び出している。

important

サービスの詳細は RegionResource を参照のこと。

以下は、cURLとJavaを使って他のRegion RESTサービスを呼び出す例である。

インスタンスからリージョンを取得する

以下のcURLまたはJavaコマンドを実行することで、リージョンの一覧を表示することができる。

Regions_GET_FromInstance.sh

コマンド：

./Regions_GET_FromInstance.sh

コード：

curl \
	"http://localhost:8080/o/headless-admin-address/v1.0/regions" \
	--user "test@liferay.com:learn"

Regions_GET_FromInstance.java

コマンド：

java -classpath .:* Regions_GET_FromInstance

コード：

public static void main(String[] args) throws Exception {
	RegionResource.Builder builder = RegionResource.builder();

	RegionResource regionResource = builder.authentication(
		"test@liferay.com", "learn"
	).build();

	Page<Region> page = regionResource.getRegionsPage(
		null, null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスの Region オブジェクトはJSONで表示される。