ヘッドレスプラットフォームとしてのLiferayの使用
Liferayでは、Webインターフェイスで利用可能なアクションと同じ種類のアクションを実行する一連のAPIを提供しています。 これは、モバイルアプリケーション、カスタムWebアプリケーション、自動化されたプロセスの作成など、機械可読形式でデータを取得する必要がある場合に不可欠です。 すぐに使用できるインターフェイスよりも多くの労力を要しますが、仕事を進める上でさらに強力な機能が備わっています。
接続する方法
クライアントがWeb APIを介してLiferay DXPに接続するには、3つの異なるアプローチがあります。
- OpenAPIの仕様に準拠した Headless REST APIs
- GraphQLの仕様に準拠した GraphQL API
- サービスビルダによって生成された、 Plain Web/REST Services
ヘッドレスREST API
LiferayのヘッドレスAPIは、Liferay DXPリソースとの RESTful インタラクションを可能にします。 これらのAPIは、RESTインターフェイスの標準を定義する OpenAPI仕様 に準拠しているため、より簡単な実装と使用が可能です。
これらのAPIの詳細情報を見るには、ブラウザを使ってLiferayのAPI Explorerにアクセスしてください。 [server]:[port]/o/api (例: http://localhost:8080/o/api). あるいはコマンドラインで、cURLを使って全リストにアクセスする。 たとえば、
curl \
"http://localhost:8080/o/api" \
-u "test@liferay.com:learn"
最も関連性の高いドキュメントは、 [server]:[port]/o/[api-name]/[api-version]/openapi.[yaml or json] にも生の形式で掲載されている。 ドキュメントは SwaggerHub にもありますが、旧バージョンを実行している場合は一致しない場合があります。
すべてのAPIのOpenAPI仕様を見るには、ブラウザを使って [server]:[port]/o/api?endpoint=[server]:[port]/o/openapi/openapi.json. (例えばhttp://localhost:8080/o/api?endpoint=http://localhost:8080/o/openapi/openapi.json）。 または、cURLを使用してJSON形式またはYAML形式で全リストをダウンロードすることもできます。 たとえば、
curl \
"http://localhost:8080/o/openapi/openapi.json" \
-o "openapi.json" \
-u "test@liferay.com:learn"
curl \
"http://localhost:8080/o/openapi/openapi.yaml" \
-o "openapi.yaml" \
-u "test@liferay.com:learn"
この完全なopenapi.[json|yaml]ファイルのダウンロードは、Liferay DXP 7.4 U69/Liferay Portal 7.4 GA69以上で可能です。
GraphQL API
GraphQL APIは、ヘッドレスREST APIと同様のインタラクションをサポートするクエリ言語ですが、若干柔軟性が高いものです。 Liferay DXPは[server][:port]/o/graphqlでこのAPIを公開しています。
GraphQLクライアント を介してAPIまたはそのドキュメントを調べることにより、詳細情報を確認できます。 Liferayには組み込みクライアントが含まれており、[server][:port]/o/api（右上の GraphQL を選択）で実行中のインスタンスで確認できます。
プレーンWeb / RESTサービス
LiferayのWebサービスは古いフレームワークの一部であり、DXPで引き続きサポートされていますが、複雑なヘッドレス操作には推奨されなくなりました。 これらのAPIは、Liferay DXPの内部動作と密接に関連しているため、新しいヘッドレスオプションが提供するパワーと柔軟性に欠けています。
ただし、Webサービスは、特定のタスクを実行するためのより簡単な方法を提供する場合があります。 使用方法については、Service Builder Web Servicesを参照してください。
機能一覧
任意のクライアントと連携する
LiferayのヘッドレスAPIはWeb経由でデータを提供するため、Web呼び出しを行うことができるすべてのアプリケーションがクライアントとして機能できます。 これらのAPIは、デフォルトでJSONコンテンツで応答しますが、XMLもネイティブでサポートしています。 拡張機能によって、必要に応じて他の方法でコンテンツを提供できます。 詳細は、 API Headers Reference を参照してください。
安全に接続する
LiferayのWebインターフェイスと同様に、ヘッドレスAPIを介したすべてのインタラクションは、特定のユーザーアカウントを使用して（またはゲストとして）行われます。 LiferayのAPIは、基本認証、OAuthトークン、Cookieの3つの認証方法をサポートしています。 詳しくは、 API Headers Reference を参照してください。 ゲストとしてAPIリクエストを行うことも可能です。詳細は、 認証されていないリクエストを行う を参照してください。
データサイズを管理しやすくする
大量のデータセットを伴う作業では、処理するクライアントに負荷がかかる場合があります。パフォーマンスの問題はユーザーにとってストレスのたまるものであり、人件費も高額になる可能性があります。 LiferayのヘッドレスAPIでは、コレクションを管理可能なチャンクに分割し、必要なデータを正確に取得する方法を提供します。
リクエストの中でpageとpageSizeパラメーターを渡すことで、一度にどれだけの情報が欲しいのか、また特定のリクエストでどの情報のサブセットが欲しいのかを API に伝えることができます。 sortパラメーターは、ページングされた応答と組み合わせても効果的であり、どの要素を最初に返すかを指定できます。
searchパラメーターはキーワード検索を実行し、エントリの任意の部分にそのキーワードを含む要素を生成します。 filterパラメーターは同様の検索を実行しますが、エントリのどこにコンテンツを含める必要があるかを正確に指定します。
fieldsパラメーターは、応答の各要素に特定のフィールドのみを列挙するように要求し、逆にrestrictFieldsパラメーターは、指定されたフィールドが返されないようにします。
flattenパラメーターは、階層APIの場合、階層コンテキストからリクエストを実行します。 これにより、たとえば、関連する組織を見つけるために組織図をトラバースする必要がなく、「マーケティング」と呼ばれる組織で検索を実行できます。
これらのパラメーターのいずれかを使用する方法の詳細は、 APIヘッダーリファレンス を参照してください。