APIの概要

Fessの提供するAPI

このドキュメントでは、 Fess が提供するAPIについて説明します。 APIを利用することで、既存のウェブシステムなどでも、簡単に Fess を検索サーバーとして使うことができます。 実際にサイトを構築しながら Fess のAPIの使い方を学びたい場合は、チュートリアルAPI編を参照してください。

APIの種類

Fess はいくつかのAPIを提供していますが、どのAPIを使用するかは http://localhost:8080/json/?type=popularword のように type パラメータに値を与えることで指定します。 type パラメータに設定できる値は以下の通りです。

search 検索API。 このAPIを利用する際は type パラメータを省略することもできます。 APIの詳細は こちらを参照してください。
popularword 人気ワードが返されます。
label 作成済みのラベルのリストが返されます。
ping サーバーの状態が返されます。

表: APIの種類