Fessのバージョン14.8では、検索利用者向けAPIがOpenAPI仕様に変更されました。この変更により、APIの利用がより簡単かつ柔軟になり、開発者がFessの機能を利用しやすくなっています。今回は、新しいAPIの概要と基本的な利用方法について紹介します。

また、従来のAPIを利用したい場合は、fess-webapp-classic-apiプラグインをインストールすることで利用することができます。過去のAPIと互換性が必要な場合はご利用ください。

APIの種類

Fessが提供している検索利用者向けAPIは以下のとおりです。

  • 検索API
  • ラベルAPI
  • 人気ワードAPI
  • サジェストAPI
  • ヘルスチェックAPI

これらのAPIはJSON形式でレスポンスを返すため、設定で「JSONレスポンス」が有効になっていることを確認してください。この設定は、管理画面の左メニュー「システム」>「全般」を選択し、全般設定の画面で「JSONレスポンス」で確認できます。「JSONレスポンス」にチェックが入っていない場合は、チェックを入れて「更新」ボタンをクリックして設定を保存してください。

検索APIの利用方法

この記事は
Members+会員の方のみ御覧いただけます

ログイン/無料会員登録

会員サービスの詳細はこちら