Files
vibemake/docs/api-gaps.md
T
Jerry 46e1b5be65 Initial commit: vibemake site
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-19 14:04:08 +08:00

45 lines
3.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 前端对接:缺少的接口和字段
对照《Community 前端接口对接文档》和 vibemake 现有页面整理。现有接口已全部接入(js/api.js);下面这些后端没有,前端目前先隐藏或降级。
## 〇、dev 环境实测发现(dev-vibemake-api.robotquan.com,2026-10-15)
- 3D 模型改用项目字段 `urdfMainUrl` / `urdfBaseUrl`(「我的 → 设置 → 3D 模型」上传 URDF 文件夹);61 个导入项目都还没有上传,首页轮播用站内自带的 4 个模型。
- 61 个项目的封面都是外部图片(raw.githubusercontent.com 46 个、YouTube 8 个等),国内加载慢,部分 5 MB 以上;建议迁到 OSS(前端对 OSS 图片自动请求 720px WebP 缩略图)。
## 一、已有接口缺少的字段
| 接口 / 结构 | 缺少字段 | 用在哪里 | 现在的处理 |
|---|---|---|---|
| Project | `forkCount` | 卡片、详情页 Fork 按钮旁的数字 | 不显示数字 |
| Project | `tags: string[]` | 详情页话题标签、搜索 | 不显示 |
| Project | `license` | 详情页标题旁的协议徽章 | 不显示 |
| Project | `featured`(或排序值) | 首页轮播精选及顺序 | 取最近发布、带 robot.json 的前 4 个 |
| PublicUser | `avatarUrl` | 所有头像 | 用昵称首字 + 按 userCode 生成颜色 |
| Comment | `parentCommentCode`、`replies` | 讨论区楼中楼回复 | 改成平铺评论,不能回复 |
| Comment | `likeCount`、`liked` | 评论点赞 | 不显示 |
| 社区项目列表 | 查询参数 `sort`(likes / comments / published) | 社区页排序下拉框、首页「本周热门」 | 隐藏排序;首页按第 1 页的 likeCount 排 |
## 二、缺少的接口
| 接口(建议) | 用在哪里 | 现在的处理 |
|---|---|---|
| `GET /api/community/projects/{code}/commits` 已发布版本的提交历史 | 详情页「动态」标签、文件列表的最近提交 | 隐藏「动态」标签 |
| `GET /api/community/projects/{code}/forks` 谁 Fork 了这个项目 | 详情页「Fork」标签 | 隐藏「Fork」标签 |
| `PATCH /api/users/me` 修改昵称 / 头像 | 个人设置(默认昵称是「用户_xxxx」,用户改不了) | 无 |
| `GET /api/users/{userCode}` + 列表加 `owner` 筛选 | 创客主页、按作者看项目 | 作者名不可点击 |
| `GET /api/me/likes` 我收藏的项目 | 社区页「我的收藏」筛选 | 隐藏 |
| 评论回复 / 评论点赞接口 | 讨论区 | 见上 |
| 跨项目的热门评论 | 首页「讨论精选」 | 隐藏该区块 |
| 创客排行 | 首页「创客」 | 隐藏该区块 |
| 订阅(Watch) | 详情页订阅按钮 | 去掉 |
## 三、3D 模型
已改为后端字段 `urdfMainUrl`:有值就在项目页、工作台显示 3D,没有就不显示(不再读取仓库里的 robot.json)。
网格按 URDF 里的相对路径从 `urdfBaseUrl` 读取;`package://包名/…` 按资源包根目录处理。
## 四、AI 助手
已按新版文档接入(`js/assistant.js`);创建 / Fork 成功后的卡片链接到工作台 `/workspace/<编码>`。