関連クエリ・関連コンテンツAPI

このページでは、クエリに対する関連情報を取得する2つのエンドポイントについて説明します。

  • GET /related-queries — クエリに対する関連クエリ候補を取得します。

  • GET /related-content — クエリに対する関連HTMLコンテンツを取得します。

いずれの結果も、管理者があらかじめ登録した関連クエリ・関連コンテンツの設定に基づきます。一致する設定がない場合は、空の結果が返ります。

レスポンスの共通エンベロープおよびエラーモデルについては APIの概要 を参照してください。

関連クエリの取得

リクエスト

HTTPメソッド GET
エンドポイント /api/v2/related-queries

Fess に、 http://<Server Name>/api/v2/related-queries?q=fess のようなリクエストを送ることで、指定したクエリに対する関連クエリ語の一覧をJSON形式で受け取ることができます。

リクエストされた検索語は、登録済みの関連クエリ設定に対して大文字・小文字を区別せずに照合されます。 q が空または未指定の場合でも、エラーにはならず、空の queries 配列が返ります。レスポンスは常に成功エンベロープです。

リクエストパラメーター

リクエストパラメーター
q 関連クエリを取得する検索語。 (例) q=fess

レスポンス

成功時には、以下のような共通エンベロープ形式のレスポンスが返ります。

{
  "response": {
    "status": 0,
    "queries": [
      "fess search",
      "fess install"
    ]
  }
}

response の各要素については以下の通りです。

レスポンス情報
queries 関連クエリ語の配列（文字列の配列）。 q が空または未指定の場合、または一致する設定がない場合は空配列になります。

使用例

curlコマンドでのリクエスト例:

curl "http://localhost:8080/api/v2/related-queries?q=fess"

エラーレスポンス

エラーレスポンス
ステータスコード 説明
405 Method Not Allowed サポートされていない HTTP メソッドが指定された場合。 Allow ヘッダーに GET が示されます。
500 Internal Server Error サーバー内部エラーが発生した場合。

関連コンテンツの取得

リクエスト

HTTPメソッド GET
エンドポイント /api/v2/related-content

Fess に、 http://<Server Name>/api/v2/related-content?q=fess のようなリクエストを送ることで、指定したクエリに対する関連HTMLコンテンツをJSON形式で受け取ることができます。

リクエストされた検索語は、登録済みの関連コンテンツ設定に対して照合されます。複数のコンテンツ項目が一致する場合、それらは改行で連結されます。 q が空または未指定の場合でも、エラーにはならず、空文字列の content が返ります。レスポンスは常に成功エンベロープです。

リクエストパラメーター

リクエストパラメーター
q 関連コンテンツを取得する検索語。 (例) q=fess

レスポンス

成功時には、以下のような共通エンベロープ形式のレスポンスが返ります。

{
  "response": {
    "status": 0,
    "content": "<div>...関連HTMLコンテンツ...</div>",
    "content_type": "html"
  }
}

response の各要素については以下の通りです。

レスポンス情報
content 関連HTMLコンテンツ（文字列）。複数項目が一致する場合は改行で連結されます。 q が空または未指定の場合、または一致する設定がない場合は空文字列になります。
content_type コンテンツの種別。値は常に html です。

使用例

curlコマンドでのリクエスト例:

curl "http://localhost:8080/api/v2/related-content?q=fess"

エラーレスポンス

エラーレスポンス
ステータスコード 説明
405 Method Not Allowed サポートされていない HTTP メソッドが指定された場合。 Allow ヘッダーに GET が示されます。
500 Internal Server Error サーバー内部エラーが発生した場合。