From f26f10e27e4a1f3bf80d3637dfa67527796a9b9e Mon Sep 17 00:00:00 2001 From: xiangmy21 <90919434+xiangmy21@users.noreply.github.com> Date: Wed, 20 Mar 2024 19:51:21 +0800 Subject: [PATCH] docs: add cos.md (#1667) --- docs/cos.md | 32 ++++++++++++++++++++++++++++++++ docs/index.md | 11 ++++++----- 2 files changed, 38 insertions(+), 5 deletions(-) create mode 100644 docs/cos.md diff --git a/docs/cos.md b/docs/cos.md new file mode 100644 index 000000000..5fd61ae1e --- /dev/null +++ b/docs/cos.md @@ -0,0 +1,32 @@ +--- +layout: default +permalink: /cos +--- + +# COS存储访问路径 + +前端访问相关文件时,需先向后端 `/static` 下对应的**同名路由**请求COS访问权限,请求所需参数可到对应文档中寻找或直接查看API接口。 + +### 比赛相关文件 + +下方 `name` 指代比赛名称,形如 `THUAI7`,对应数据库 `contest` 表中的 `name` + +- 代码:`name/code/team_id/code_id.suffix` + +- 公告文件:`name/notice/notice_id/filename` +- 天梯回放:`name/arena/room_id/filename` +- (选择性实现) 后台比赛回放:`name/competition/round_id/filename` +- (选择性实现) 地图:`name/map/filename` + +### Info页面相关文件 + +- 新生导师谈话记录:`chat_record/application_id/filename` +- 公告文件:`upload/filename` + +### 公开静态资源文件 + +这部分文件前端可直接通过 `https://static.eesast.com/` 解析到存储桶访问。 + +- 展示图片:`public/images/filename` +- WebGL资源:`public/WebGL/name/filename` +- 其他可公开文件:`public/files/filename` diff --git a/docs/index.md b/docs/index.md index 84bf91171..0becf6494 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,5 +1,6 @@ -- [用户逻辑](https://eesast.github.io/web/user) -- 代码提交逻辑(待补充) -- 天梯逻辑(待补充) -- 静态资源管理(待补充) -- 新生导师逻辑(待补充) +- [用户逻辑](https://eesast.github.io/web/user) +- [COS存储桶访问路径约定](https://eesast.github.io/web/cos) +- 代码提交逻辑(待补充) +- 天梯逻辑(待补充) +- 静态资源管理(待补充) +- 新生导师逻辑(待补充)