palemoky/chinese-poetry-api

어떤 프로젝트인가요?

핵심 기능

• 01시, 작가, 왕조, 장르를 위한 REST 및 GraphQL API를 제공합니다.
• 02lang 매개변수로 간체와 번체 중국어를 전환합니다.
• 03전문 검색과 제목·내용·작가 검색을 지원합니다.
• 04한 글자 일치 등 필터를 적용해 시를 무작위로 가져올 수 있습니다.
• 05IP별 요청 제한과 커서 페이지네이션을 제공합니다.
• 06amd64 및 arm64용 Docker 이미지로 배포됩니다.

활용 사례

• 앱이나 웹사이트에 고전 시 검색 또는 인용 기능을 추가합니다.
• 무작위 조회와 글자 필터링을 활용해 飞花令 또는 시 퀴즈 게임을 만듭니다.
• 실제에 가까운 자체 호스팅 데이터 소스를 대상으로 웹 스크래핑을 연습합니다.
• 번체 또는 간체 표기의 중국 시 데이터를 조회합니다.

빠른 시작

1. 1

   Docker로 실행하기

   docker run -d -p 1279:1279 palemoky/chinese-poetry-api:latest
2. 2

   서브모듈을 포함해 리포지토리 클론하기

   git clone --recurse-submodules --depth=1 https://github.com/palemoky/chinese-poetry-api.git
3. 3

   Makefile로 데이터를 처리하고 서버 시작하기

   make process-data
4. 4

   서버 시작하기

   make run-server

사용 전 알아둘 점

• !Poetry 데이터는 서브모듈에서 가져오므로 서브모듈을 포함해 클론하거나 별도로 가져와야 합니다.
• !Makefile 워크플로에서는 서버를 시작하기 전에 데이터 처리 단계를 실행해야 합니다.

토픽

자주 묻는 질문

chinese-poetry-api은(는) 무엇인가요?

간체 및 번체 중국어로 된 약 40만 편의 고전 시 데이터셋을 REST 및 GraphQL 엔드포인트로 제공하는 Go 기반 API 서비스입니다. chinese-poetry-api는 당나라 시, 송나라 사(詞), 원나라 산곡 등을 비롯해 약 40만 편의 작품을 담은 중국 고전 시 데이터베이스를 제공하는 Go 서비스입니다. 왕조, 작가, 장르별로 시를 조회하고 필터링할 수 있으며, 제목·내용·작가로 검색하거나 무작위로 시를 가져올 수 있습니다. 飞花令 같은 게임을 위해 한 글자로 필터링하는 기능도 제공합니다.

chinese-poetry-api은(는) 무료로 사용할 수 있나요? 라이선스는 무엇인가요?

chinese-poetry-api은(는) GPL-3.0 라이선스의 오픈소스입니다. 상업용 제품에 사용하기 전에 라이선스 조건을 확인하세요.

chinese-poetry-api은(는) 아직 유지보수되고 있나요?

활발히 유지보수 중. chinese-poetry-api의 마지막 커밋은 2026년 10월 7일입니다.

chinese-poetry-api은(는) 어디에 사용할 수 있나요?

앱이나 웹사이트에 고전 시 검색 또는 인용 기능을 추가합니다. 무작위 조회와 글자 필터링을 활용해 飞花令 또는 시 퀴즈 게임을 만듭니다. 실제에 가까운 자체 호스팅 데이터 소스를 대상으로 웹 스크래핑을 연습합니다. 번체 또는 간체 표기의 중국 시 데이터를 조회합니다.

chinese-poetry-api는 어떻게 설치하나요?

Docker로 실행하기: docker run -d -p 1279:1279 palemoky/chinese-poetry-api:latest 서브모듈을 포함해 리포지토리 클론하기: git clone --recurse-submodules --depth=1 https://github.com/palemoky/chinese-poetry-api.git Makefile로 데이터를 처리하고 서버 시작하기: make process-data 서버 시작하기: make run-server

chinese-poetry-api은(는) 어디서 받을 수 있나요?

소스 코드와 설치 방법은 GitHub에 있습니다: https://github.com/palemoky/chinese-poetry-api