korean-open-dict-api-types

Simple type definitions for the Korean Open Dict Open API.

대한민국 국립국어원에서 운영하는 우리말샘 오픈 API의 타입스크립트 타입 정의입니다.

Installation

Install with npm / yarn / pnpm:

npm install korean-open-dict-api-types
yarn add korean-open-dict-api-types
pnpm add korean-open-dict-api-types

Docs

Search API

• Endpoint: GET https://opendict.korean.go.kr/api/search
• Params
  • interface SearchParam
  • interface SearchWordParam
  • interface SearchExampleParam
  • interface AdvancedSearchParam
  • interface AdvancedSearchWordParam
  • interface AdvancedSearchExampleParam
• Response
  • interface SearchResponse

View API

• Endpoint: GET https://opendict.korean.go.kr/api/view
• Params
  • interface ViewParam
  • interface ViewWordParam
  • interface ViewExampleParam
• Response
  • interface ViewResponse

Error Codes

• Error Code
  • interface KoreanOpenDictApiError
    • enum KoreanOpenDictApiErrorCode