ナレッジベースAPIの基本

Documentation Menu
戻る

ナレッジベースAPIの基本

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

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

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

docker run -it -m 8g -p 8080:8080 liferay/dxp:7.4.13-u55。

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

次に、以下の手順を実行します。

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

    curl https://resources.learn.liferay.com/dxp/latest/ja/collaboration-and-social/knowledge-base/developer-guide/liferay-t3x7.zip -O

    unzip liferay-t3x7.zip

  2. ログインすると、 サイトのIDを取得します 。 このIDは、いくつかのサービス呼び出しで使用します。

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

    ./KnowledgeBaseArticle_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"

  4. メニュー アイコン（Menu icon）をクリックし、 ［コンテンツとデータ］ → ［ナレッジベース］ に移動します。 新しいナレッジベースの記事が追加されたことを確認します。

    新しいナレッジベースの記事が追加されたことを確認します。

  5. RESTサービスは、Javaクライアントを使って呼び出すこともできます。 curl フォルダから、 java フォルダに移動します。 ソースファイルをコンパイルします。

    javac -classpath .:* *.java

  6. KnowledgeBaseArticle_POST_ToSite.javaクラスを実行します。 siteIdシステムプロパティ値をサイトのIDに置き換えます。

    java -classpath .:* -DsiteId=1234 KnowledgeBaseArticle_POST_ToSite

    Javaクラスにより、新しいナレッジベース記事が作成されました。

cURLコマンドの検証

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

curl \
	-H "Content-Type: application/json" \
	-X POST \
	"http://localhost:8080/o/headless-delivery/v1.0/sites/${1}/knowledge-base-articles" \
	-d "{\"articleBody\": \"Foo\", \"title\": \"Able\"}" \
	-u "[email protected]: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 "[email protected]:learn" 基本的な認証情報
note

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

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

Javaクラスを調べる

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

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"[email protected]", "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エクスプローラーで確認できます。

note

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

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

important

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

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

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

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

KnowledgeBaseArticles_GET_FromSite.sh

コマンド:

./KnowledgeBaseArticles_GET_FromSite.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/sites/${1}/knowledge-base-articles" \
	-u "[email protected]:learn"

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(
			"[email protected]", "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で取得します。

tip

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

KnowledgeBaseArticle_GET_ById.sh

コマンド:

./KnowledgeBaseArticle_GET_ById.sh 1234

コード:

curl \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	-u "[email protected]:learn"

KnowledgeBaseArticle_GET_ById.java

コマンド:

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticle_GET_ById

コード:

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"[email protected]", "learn"
		).build();

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

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

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

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

KnowledgeBaseArticle_PATCH_ById.sh

コマンド:

./KnowledgeBaseArticle_PATCH_ById.sh 1234

コード:

curl \
	-H "Content-Type: application/json" \
	-X PATCH \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	-d "{\"articleBody\": \"Bar\"}" \
	-u "[email protected]:learn"

KnowledgeBaseArticle_PATCH_ById.java

コマンド:

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticle_PATCH_ById

コード:

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"[email protected]", "learn"
		).build();

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

	System.out.println(knowledgeBaseArticle);
}

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

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

KnowledgeBaseArticle_PUT_ById.sh

コマンド:

./KnowledgeBaseArticle_PUT_ById.sh 1234

コード:

curl \
	-H "Content-Type: application/json" \
	-X PUT \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	-d "{\"articleBody\": \"Goo\", \"title\": \"Baker\"}" \
	-u "[email protected]:learn"

KnowledgeBaseArticle_PUT_ById.java

コマンド:

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticle_PUT_ById

コード:

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"[email protected]", "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に置き換えてください。

KnowledgeBaseArticle_DELETE_ById.sh

コマンド:

./KnowledgeBaseArticle_DELETE_ById.sh 1234

コード:

curl \
	-X DELETE \
	"http://localhost:8080/o/headless-delivery/v1.0/knowledge-base-articles/${1}" \
	-u "[email protected]:learn"

KnowledgeBaseArticle_DELETE_ById.java

コマンド

java -classpath .:* -DknowledgeBaseArticleId=1234 KnowledgeBaseArticle_DELETE_ById

コード:

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

	KnowledgeBaseArticleResource knowledgeBaseArticleResource =
		builder.authentication(
			"[email protected]", "learn"
		).build();

	knowledgeBaseArticleResource.deleteKnowledgeBaseArticle(

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

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

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

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

Not finding what you're looking for?

Pardon our dust as we revamp and transition our product documentation to this site. If something seems missing, please check Liferay Help Center documentation for Liferay DXP 7.2 and previous versions.

Try Liferay's Help Center