ご覧のページは、お客様の利便性のために一部機械翻訳されています。また、ドキュメントは頻繁に更新が加えられており、翻訳は未完成の部分が含まれることをご了承ください。最新情報は都度公開されておりますため、必ず英語版をご参照ください。翻訳に問題がある場合は、こちらまでご連絡ください。

ナレッジベースAPIの基本

Liferay のナレッジベースアプリを使用すると、ナレッジベースの記事を作成およびナレッジベースを管理できますが、Liferay の REST API を使用することもできます。ナレッジベースのコンテンツを作成・管理するために、これらのサービスを呼び出します。

ナレッジベースの記事を追加する

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:2025.q1.6-lts

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

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

Knowledge Base API Basicsをダウンロードして解凍します。

curl https://resources.learn.liferay.com/examples/liferay-t3x7.zip -O

unzip liferay-t3x7.zip

サインインすると、サイトの ID を取得します。このIDはいくつかのサービスコールで使用することになります。

cURLスクリプトを使用して、サイトに新しいナレッジベースの記事を追加します。コマンドラインで、curlフォルダに移動します。サイト ID をパラメータとして、 KnowledgeBaseArticles_POST_ToSite.sh スクリプトを実行します。例えば、

./KnowledgeBaseArticles_POST_ToSite.sh 1234

JSON応答では、新しいナレッジベースの記事が追加されたことを示しています。

{
  "articleBody" : "Foo",
  "creator" : {
    "additionalName" : "",
    "contentType" : "UserAccount",
    "familyName" : "Test",
    "givenName" : "Test",
    "id" : 20125,
    "name" : "Test Test"
  },
  "customFields" : [ ],
  "dateCreated" : "2022-07-28T21:25:57Z",
  "dateModified" : "2022-07-28T21:25:57Z",
  "description" : "",
  "encodingFormat" : "text/html",
  "externalReferenceCode" : "0bace9ad-39ea-79b5-902e-c873806b8bd7",
  "friendlyUrlPath" : "able",
  "id" : 42447,
  "keywords" : [ ],
  "numberOfAttachments" : 0,
  "numberOfKnowledgeBaseArticles" : 0,
  "parentKnowledgeBaseArticleId" : 0,
  "relatedContents" : [ ],
  "siteId" : 20121,
  "subscribed" : false,
  "taxonomyCategoryBriefs" : [ ],
  "title" : "Able"
}

メニュー アイコン () をクリックし、 コンテンツとデータ → ナレッジベースに移動します。新しいナレッジベースの記事が追加されたことを確認します。
RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。ソースファイルをコンパイルします。
```
javac -classpath .:* *.java
```
KnowledgeBaseArticles_POST_ToSite.java クラスを実行します。 siteIdシステムプロパティ値をサイトのIDに置き換えます。
```
java -classpath .:* -DsiteId=1234 KnowledgeBaseArticles_POST_ToSite
```
Javaクラスにより、新しいナレッジベース記事が作成されました。

cURLコマンドの検証

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

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/sites/${1}/knowledge-base-articles" \
	--data-raw '
		{
			"articleBody": "Foo",
			"title": "Able"
		}' \
	--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-delivery/v1.0/sites/${1}/knowledge-base-articles"`	RESTサービスのエンドポイント
`-d "{\"articleBody\": \"Foo\", \"title\": \"Able\"}"`	お客様が掲載を希望するデータ
`-u "test@liferay.com:learn"`	基本的な認証情報

注

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

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

Javaクラスを調べる

KnowledgeBaseArticles_POST_ToSite.java クラスは、ナレッジベース関連のサービスを呼び出してナレッジベースの記事を追加します。

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	KnowledgeBaseArticle knowledgeBaseArticle =
		knowledgeBaseArticleResource.postSiteKnowledgeBaseArticle(
			Long.valueOf(System.getProperty("siteId")),
			new KnowledgeBaseArticle() {
				{
					articleBody = "Foo";
					title = "Charlie";
				}
			});

	System.out.println(knowledgeBaseArticle);
}

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

行（省略形）	説明
`KnowledgeBaseArticleResource.Builder builder = ...`	`Builder`を取得し、`KnowledgeBaseArticleResource`サービスインスタンスを生成します。
`KnowledgeBaseArticleGroupResource knowledgeBaseArticleGroupResource = builder.authentication(...).build();`	基本認証を指定し、`KnowledgeBaseArticleResource`サービスインスタンスを生成します。
`KnowledgeBaseArticle knowledgeBaseArticle = knowledgeBaseArticleResource.postSiteKnowledgeBaseArticle(...);`	`knowledgeBaseArticleResource.postSiteKnowledgeBaseArticle`メソッドを呼び出し、データを投稿に渡します。

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

注

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

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

重要

サービスの詳細については、 KnowledgeBaseArticleResource を参照してください。

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

サイトからナレッジベース記事を取得する

次のcURLまたはJavaコマンドを実行すると、全てのサイトからナレッジベースの記事を取得できます。 1234をサイトのIDに置き換えてください。

KnowledgeBaseArticles_GET_FromSite.sh

コマンド：


./KnowledgeBaseArticles_GET_FromSite.sh 1234

コード：

KnowledgeBaseArticles_GET_FromSite.java

コマンド：

java -classpath .:* -DsiteId=1234 KnowledgeBaseArticles_GET_FromSite

コード：

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	Page<KnowledgeBaseArticle> page =
		knowledgeBaseArticleResource.getSiteKnowledgeBaseArticlesPage(
			Long.valueOf(System.getProperty("siteId")), null, null, null,
			null, Pagination.of(1, 2), null);

	System.out.println(page);
}

インスタンスのKnowledgeBaseArticlesオブジェクトがJSONで表示されます。

ナレッジベースの記事を取得する

以下のcURLまたはJavaコマンドを使用し、特定のナレッジベースの記事をIDで取得します。

ヒント

KnowledgeBaseArticles_GET_FromSite.[java|sh] を使用して、インスタンス Knowledge Base Article ID を取得します。

ナレッジベース記事_GET_ById.sh

コマンド：

./KnowledgeBaseArticles_GET_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	--user "test@liferay.com:learn"

ナレッジベース記事_GET_ById.java

コマンド：

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_GET_ById

コード：

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	System.out.println(
		knowledgeBaseArticleResource.getKnowledgeBaseArticle(
			Long.valueOf(System.getProperty("knowledgeBaseArticleId"))));
}

KnowledgeBaseArticleフィールドは、JSONで表示されます。

ナレッジベースの記事にパッチを適用する

次のcURLおよびJavaコマンドを使用して、既存のナレッジベースの記事を部分的に編集します。 1234をナレッジベース記事のIDに置き換えてください。修正したいフィールドとその新規値を指定します。

ナレッジベース記事_PATCH_ById.sh

コマンド：

./KnowledgeBaseArticles_PATCH_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	--data-raw '
		{
			"articleBody": "Bar"
		}' \
	--header "Content-Type: application/json" \
	--request "PATCH" \
	--user "test@liferay.com:learn"

ナレッジベース記事_PATCH_ById.java

コマンド：

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_PATCH_ById

コード：

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	KnowledgeBaseArticle knowledgeBaseArticle =
		knowledgeBaseArticleResource.patchKnowledgeBaseArticle(
			Long.valueOf(System.getProperty("knowledgeBaseArticleId")),
			new KnowledgeBaseArticle() {
				{
					articleBody = "Bar";
				}
			});

	System.out.println(knowledgeBaseArticle);
}

ナレッジベース記事を上書きする

次のcURLおよびJavaコマンドを使用して、既存のナレッジベースの記事を完全に上書きします。 1234をナレッジベース記事のIDに置き換えてください。

ナレッジベース記事_PUT_ById.sh

コマンド：

./KnowledgeBaseArticles_PUT_ById.sh 1234

コード：

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	--data-raw '
		{
			"articleBody": "Goo",
			"title": "Baker"
		}' \
	--header "Content-Type: application/json" \
	--request "PUT" \
	--user "test@liferay.com:learn"

ナレッジベース記事_PUT_ById.java

コマンド：

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_PUT_ById

コード：

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	KnowledgeBaseArticle knowledgeBaseArticle =
		knowledgeBaseArticleResource.putKnowledgeBaseArticle(
			Long.valueOf(System.getProperty("knowledgeBaseArticleId")),
			new KnowledgeBaseArticle() {
				{
					articleBody = "Goo";
					title = "Dog";
				}
			});

	System.out.println(knowledgeBaseArticle);
}

ナレッジベース記事を削除する

次のcURLおよびJavaコマンドを使用して、既存のナレッジベースの記事を削除します。 1234をナレッジベース記事のIDに置き換えてください。

ナレッジベース記事_DELETE_ById.sh

コマンド：

./KnowledgeBaseArticles_DELETE_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	--request "DELETE" \
	--user "test@liferay.com:learn"

ナレッジベース記事_DELETE_ById.java

コマンド

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticles_DELETE_ById

コード：

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"test@liferay.com", "learn"
		).build();

	knowledgeBaseArticleResource.deleteKnowledgeBaseArticle(
		Long.valueOf(System.getProperty("knowledgeBaseArticleId")));
}

ナレッジベースフォルダサービス

ナレッジベースフォルダ用のcURLコマンドとJavaクラスは、ナレッジベースの記事と同じように機能します。

ファイル	説明
`KnowledgeBaseFolders_DELETE_ById.[java\\|sh]`	ナレッジベースフォルダをIDで削除する。
`KnowledgeBaseFolders_GET_ById.[java\\|sh]`	特定のナレッジベースフォルダをIDで取得する
`KnowledgeBaseFolders_PATCH_ById.[java\\|sh]`	IDでナレッジベースフォルダにパッチを適用する。
`KnowledgeBaseFolders_POST_ToSite.[java\\|sh]`	ナレッジベースフォルダをサイトに投稿する。
`KnowledgeBaseFolders_PUT_ToSite.[java\\|sh]`	ナレッジベースフォルダをIDで上書きする。
`KnowledgeBaseFolders_GET_FromSite.[java\\|sh]`	サイトからナレッジベースフォルダの一覧を取得する。

API エクスプローラーには、すべての KnowledgeBaseArticle および KnowledgeBaseFolder サービスとスキーマが表示され、各サービスを試すためのインターフェースがあります。

Capability:

Content Management System

Resource Type:

Official Documentation

Feature:

Knowledge Base

Deployment Approach:

Liferay PaaS

Liferay SaaS

Liferay Self-Hosted

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/sites/${1}/knowledge-base-articles" \
	--user "test@liferay.com:learn"

Capabilities

View All Capabilities

Product

Education

Knowledge Base