API 개요

Fess 에서 제공하는 API

본 문서에서는 Fess 가 제공하는 API에 대해 설명합니다. API를 활용하면 기존 웹 시스템 등에서도 Fess 를 검색 서버로 사용할 수 있습니다.

Fess 의 API 엔드포인트는 다음 기본 URL로 제공됩니다.

http://<Server Name>/api/v1/

예를 들어, 로컬 환경에서 실행 중인 경우 다음과 같습니다.

http://localhost:8080/api/v1/

현재 버전에서는 API 사용에 인증이 필요하지 않습니다. 단, 관리 화면의 각종 설정에서 API를 활성화해야 합니다.

모든 API 엔드포인트는 GET 메서드로 액세스합니다.

모든 API 응답은 JSON 형식 으로 반환됩니다(GSA 호환 API 제외). 응답의 Content-Type 은 application/json 입니다.

API 요청이 실패한 경우 적절한 HTTP 상태 코드와 함께 오류 정보가 반환됩니다.

표: HTTP 상태 코드

Fess 는 다음 API를 제공합니다.

표: API 유형