Open API

오픈 DB의 단어 검색 기능을 API에서 만나보세요.

기본 정보

GET/api/words/search

모드별 필터링 및 정렬 옵션을 적용하여 오픈DB의 단어 리스트를 반환합니다.

쿼리 파라미터

1. 필수 및 공통 옵션

파라미터타입설명기본값
modestring게임 모드 (kor-start, kor-end, kung, hunmin, jaqi)kor-start
qstring검색어. 모드에 따라 시작자, 끝자, 또는 초성-
limitnumber최대 검색 결과 수100
sortBystring정렬 기준 (abc, length, attack)length

2. 세부 필터링 (Advanced)

파라미터타입설명기본값
mannerstring단어 필터 (man, jen, eti)man
minLengthnumber최소 글자 수2
maxLengthnumber최대 글자 수100
duemboolean두음법칙 적용 여부true
missionstring포함해야 할 특정 글자""
themeIdnumber자음 퀴즈 모드 사용 시 필수 테마 Id-

Response Body

Success (Array)

  • word: string검색된 단어의 명칭
  • nextWordCount: number해당 단어 이후에 이어질 수 있는 단어의 개수

Example

[
  {
    "word": "사과",
    "nextWordCount": 15
  },
  {
    "word": "해질녘",
    "nextWordCount": 0
  }
]

API 사용 예제

A. 일반적인 끝말잇기 (시작 단어 찾기)

GET /api/words/search?mode=kor-start&q=가&manner=man&limit=50&sortBy=length

B. 쿵쿵따 모드

GET /api/words/search?mode=kung&q=나

C. 훈민정음 (초성 퀴즈)

GET /api/words/search?mode=hunmin&q=ㄱㄴ

Response Status Code

  • 200:OK
  • 400:
    Bad Request

    필수 파라미터 누락 또는 유효하지 않은 요청

  • 500:Internal Server Error