
如何快速部署自己的古诗词APIchinese-poetry-api三步上手完整指南【免费下载链接】chinese-poetry-api 诗泉高性能中国古诗词 API 服务项目地址: https://gitcode.com/gh_mirrors/ch/chinese-poetry-api诗泉chinese-poetry-api是一款基于 Go 语言的高性能中国古诗词 API 服务内置近 40 万首唐诗宋词元曲支持 REST 与 GraphQL 双接口、简繁体一键切换和全文搜索。本文带你用三步在本地快速部署自己的古诗词 API全程不需要编写任何代码。一、为什么需要自己的古诗词 API部署一套自己的古诗词 API 服务后你可以轻松实现这些场景随机诗词推荐按作者、朝代、体裁随机抽取如「李白 五言绝句」飞花令玩法用单个字如春匹配诗句适合做小游戏全文搜索按标题、内容、作者多维度检索近 40 万首诗词简繁体双语同一接口通过lang参数切换简体中文 / 繁体中文服务内置 SQLite 全文索引与 IP 限流保护单文件数据库、零外部依赖非常适合个人学习、小程序和创意项目。二、快速部署Docker 一键启动推荐这是最快的部署方式官方镜像支持 amd64 / arm64 多架构首次启动会自动下载数据库并校验完整性逻辑见 scripts/startup.sh。一键运行容器docker run -d -p 1279:1279 palemoky/chinese-poetry-api:latest使用 docker-compose 管理如果希望固定端口、方便重启推荐用仓库自带的 docker-compose.ymlcp .env.example .env # 生成配置文件端口、限流参数 docker compose up -d # 启动服务.env文件中可以控制变量默认值说明PORT1279API 服务端口RATE_LIMIT_RPS10每秒请求上限RATE_LIMIT_BURST20突发请求容量 数据会被挂载到poetry-data卷中重启容器不会丢失数据库。三、验证服务3 条命令测通 API服务启动后约 30 秒首次需下载数据库用以下命令验证# 健康检查 curl http://localhost:1279/api/v1/health # 随机抽取一首诗支持按作者/朝代/体裁过滤 curl http://localhost:1279/api/v1/poems/random?author李白 # 全文搜索「静夜思」 curl http://localhost:1279/api/v1/poems/search?q静夜思 # 切换到繁体中文 curl http://localhost:1279/api/v1/poems?langzh-Hant返回类似这样的结果就代表部署成功{ title: 静夜思, content: 床前明月光……, author: { name: 李白 } }仓库还提供了现成的请求集合 requests.http配合 VS Code 的 REST Client 插件可以像接口文档一样逐条调试覆盖随机诗、搜索、作者、朝代、GraphQL 等全部端点。四、源码构建部署不用 Docker 的备选方案如果你的环境没有 Docker也可以直接从源码构建。项目用 Git Submodules 管理诗词原始数据见 .gitmodules# 1. 克隆仓库必须带上 submodules否则会缺少诗词数据 git clone --recurse-submodules --depth1 https://gitcode.com/gh_mirrors/ch/chinese-poetry-api cd chinese-poetry-api # 2. 构建并处理数据生成 SQLite 数据库需安装 Go 和 Make make process-data # 3. 启动 API 服务器 make run-server常用命令一览完整说明可运行make help见 Makefile命令作用make build构建处理器与服务器二进制make process-data处理诗词数据生成数据库make run-server启动 API 服务器默认端口 1279make docker-build/make docker-run自行构建并运行 Docker 镜像make test运行全部测试五、常用配置项速查核心配置集中在 config.yaml关键项如下server.port服务端口默认1279也可用环境变量PORT覆盖rate_limit限流开关与速率默认 10 QPS / 突发 20防止接口被滥用search.max_results搜索最大返回条数默认 1000database.max_open_conns数据库连接池设为0时按 CPU 核心数自动检测修改端口最快的方式docker run -d -p 8080:1279 palemoky/chinese-poetry-api:latest外部映射为 8080 即可。六、部署常见问题Q启动后访问 404 或连接拒绝A确认端口映射正确docker ps查看并等待首次数据库下载完成可用curl http://localhost:1279/api/v1/health轮询。Q遇到 429 错误A这是内置 IP 限流在生效调大.env中的RATE_LIMIT_RPS后重启容器即可。Q数据包含哪些分类A涵盖五言/七言绝句律诗、宋词、元曲、乐府诗、诗经等总量近 40 万首可通过/api/v1/stats查看实时统计。至此一套属于自己的高性能古诗词 API 服务就部署完成了。下一步可以试试把它接入小程序、飞书机器人或自己的网站让「床前明月光」随时随叫随到 【免费下载链接】chinese-poetry-api 诗泉高性能中国古诗词 API 服务项目地址: https://gitcode.com/gh_mirrors/ch/chinese-poetry-api创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考