Skip to content

Latest commit

 

History

History
32 lines (23 loc) · 771 Bytes

api-overview.rst

File metadata and controls

32 lines (23 loc) · 771 Bytes

Overview

Provided API in |Fess|

This document describes API provided by |Fess|. Using |Fess| API, you can construct a search system with your existing web applications.

API Type

|Fess| provides several search APIs. Using type request parameter, API is specified, such as http://<Server Name>/json/?type=popularword. Available type is as below.

.. tabularcolumns:: |p{3cm}|p{12cm}|
API Type
search Search results are returned. search is a default type.
popularword Poplular words are returned.
label Registered labels are returned.
ping |Fess| server state is returned.