Skip to content

API 文档(Swagger 网关)

所有 HTTP 微服务都提供交互式 OpenAPI/Swagger 文档,由独立的 docs 网关 (nginx)聚合,经管理端 nginx 的 /doc/ 前缀暴露:

前缀服务文档入口(本地)
/api-admin管理端 API(gin-swagger)http://localhost:8080/doc/api-admin/swagger/index.html
/api-live观众端 / 直播聊天 APIhttp://localhost:8080/doc/api-live/swagger/index.html
/api-schedulerWorker Webhookhttp://localhost:8080/doc/api-scheduler/swagger/index.html
/service-rag知识库服务(FastAPI /docs)http://localhost:8080/doc/service-rag/docs
/service-tts语音服务(FastAPI /docs)http://localhost:8080/doc/service-tts/docs

网关落地页:http://localhost:8080/doc/。生产环境将 localhost:8080 替换为 实际入口域名即可;网关内部通过 docs 微服务的 nginx 按前缀反代到各服务。

鉴权说明

  • 管理端写操作与 /api/users/api/admin/*(除 login/me/logout)需要登录会话
  • 观众端接口(直播/聊天/拉流)与 Worker Webhook 保持公开

灵播 LingCast · 端到端口播数字人平台