ltx 8d1928a247 docs(website): clarify production competition management URL

Document https://jitsi-web.yuedongsports.com/ as the production admin base and distinguish its public management endpoint from the separately configured upstream competition service URL.

2026-10-19 16:48:56 +08:00

4.4 KiB

Raw Blame History

官网赛事信息后端接口

功能与调用链

YD_Event.Web 的“官网赛事信息”页面请求当前环境的 GET/PUT /api/website-competition。此接口由 YD_Event.Admin 提供，沿用后台登录认证；管理页不需要填写接口地址或管理密钥。

正式环境访问基地址为 https://jitsi-web.yuedongsports.com/，管理接口完整地址为 https://jitsi-web.yuedongsports.com/api/website-competition。此地址是后台对外入口；CompetitionApi:AdminUrl 是后端转发到官网赛事服务的地址，需单独配置。

YD_Event.Admin 在服务端把请求转发到官网赛事服务的 /api/competition/admin。服务间密钥只保存在服务器配置中，不发送给浏览器。官网赛事服务负责校验数据、持久化草稿或发布状态，并通知公开页面刷新。本仓库不新增赛事数据库表。

YD_Event.Web 管理页
  → 当前域名 /api/website-competition（后台登录态）
  → YD_Event.Admin（附加服务间 Bearer 密钥）
  → 官网赛事服务 /api/competition/admin
  → 持久化赛事 JSON / 官网公开接口

接口

方法	路径	说明
`GET`	`/api/website-competition`	读取当前环境的完整赛事草稿，包括未发布内容
`PUT`	`/api/website-competition`	保存赛事信息及 `published` 状态，JSON 请求体上限为 8 MB

两个方法都要求已有的后台登录态。控制器原样转发上游的 JSON 响应和 HTTP 状态码。数据的主要结构如下；详细字段由管理页 Excel 模板及官网赛事服务校验规则约束。

{
  "published": false,
  "competition": { "nameZh": "", "nameEn": "", "dateZh": "", "dateEn": "", "venueZh": "", "venueEn": "" },
  "notice": { "enabled": false, "textZh": "", "textEn": "" },
  "schedule": { "currentId": "", "callingId": "", "upcomingCount": 3, "items": [] },
  "results": { "overall": [], "challenge": [], "battle": [] },
  "players": [],
  "records": []
}

服务端配置

配置键	环境变量写法	说明
`CompetitionApi:AdminUrl`	`CompetitionApi__AdminUrl`	官网赛事服务管理接口完整 URL；默认 `http://127.0.0.1:8787/api/competition/admin`
`CompetitionApi:AdminToken`	`CompetitionApi__AdminToken`	与官网赛事服务 `COMPETITION_ADMIN_TOKEN` 相同的服务间密钥
`CompetitionApi:AdminTokenFile`	`CompetitionApi__AdminTokenFile`	可选，密钥文件的绝对路径；未配置密钥值时读取
`COMPETITION_ADMIN_TOKEN`	`COMPETITION_ADMIN_TOKEN`	密钥值的兼容性回退配置

官网赛事服务要求 COMPETITION_ADMIN_TOKEN 至少 32 字符。不要将密钥写入前端环境变量、前端代码或公开仓库。若两个服务不在同一网络命名空间，必须配置可由 YD_Event.Admin 访问的 CompetitionApi__AdminUrl，不能使用默认的 127.0.0.1。

部署步骤

启动官网赛事服务，设置持久化数据路径及 COMPETITION_ADMIN_TOKEN；其健康检查为 GET /api/competition/ping。
在 YD_Event.Admin 的运行环境配置管理接口 URL 与相同的服务间密钥，然后启动或重启后端。Startup 已注册专用 WebsiteCompetition HttpClient。
将后台站点同源的 /api/website-competition 路由转发到 YD_Event.Admin。不要把该路径直接暴露或转发到官网赛事服务管理接口。
管理员登录 YD_Event.Web 后打开“官网赛事信息”，导入 .xlsx、核对草稿并保存；需要公开展示时再开启“公开发布”。

错误排查

状态	常见原因
`401/403`	后台未登录或无权访问；若由上游返回，也可能是服务间密钥不一致
`413`	`PUT` 请求体超过 8 MB
`502`	官网赛事服务无法连接
`503`	服务端密钥缺失、密钥文件不可读取，或上游 URL 无效
`504`	官网赛事服务超过 30 秒未响应

控制器不会在错误响应或日志中输出密钥。保存时上游的字段校验错误会原样返回，管理页会展示错误信息。

验证

dotnet build .\YD_Event.Web.Entry\YD_Event.Web.Entry.csproj --no-restore

确认官网赛事服务的 /api/competition/ping 返回成功；使用已有后台登录态访问 GET /api/website-competition，应返回上述赛事结构。未经登录直接访问应被后台认证拒绝。PUT 应先在测试环境使用草稿数据验证，再按发布流程操作。

4.4 KiB Raw Blame History Unescape Escape