관련 쿼리·관련 콘텐츠 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 서버 내부 오류가 발생한 경우.