Skip to content

fix(api): 精确描述版面概要响应 - #60

Open
shellRaining wants to merge 3 commits into
mainfrom
fix/board-all-response-schema
Open

fix(api): 精确描述版面概要响应#60
shellRaining wants to merge 3 commits into
mainfrom
fix/board-all-response-schema

Conversation

@shellRaining

@shellRaining shellRaining commented Jul 27, 2026

Copy link
Copy Markdown
Owner

变更

  • 新增 BoardSummary,仅声明版面概要接口实际返回的 10 个字段
  • /board/all 中的 BoardGroup.boards 改为引用 BoardSummary
  • /board/search 的成功响应改为 BoardSummary 数组
  • 避免在上述接口中展示 logoUri 等仅属于详情响应的字段,同时保留实际返回的 showShareTip
  • 说明 /board/{boardId} 单条查询与 /board/ 批量查询返回相同字段,并记录批量接口的去重、缺失 ID 和响应顺序语义
  • 增加生成 OpenAPI 的回归检查

证据

/board/all 的匿名响应样本包含 266 个版面,/board/search 使用校园关键词的实时响应包含 3 个版面;两者字段集合一致,均未出现 logoUri。logoUri 继续保留在 /board/ 和 /board/{boardId} 使用的 Board Schema 中。

旧前端明确将 /board/ 用于收藏版面的批量查询,将 /board/{boardId} 用于版面页、主题页和编辑页的单条查询。实时探测确认两者字段相同;批量接口会去重、忽略部分不存在的 ID,且调用方不应依赖响应顺序。

验证

  • vp run api#generate
  • vp run api#test(19 tests passed)
  • vp run api#check
  • vp run -r build
  • vp run website#check:colors
  • vp exec knip --include files,exports,types
  • vp run -r test(479 tests passed)

全仓库 vp run ready 在 origin/main 已存在的 README.md 格式检查处停止;该文件与 origin/main 内容一致且不在本 PR 中。

@vercel

vercel Bot commented Jul 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cc98 Ready Ready Preview, Comment Jul 27, 2026 4:05pm
cc98-api-docs Ready Ready Preview, Comment Jul 27, 2026 4:05pm
1 Skipped Deployment
Project Deployment Actions Updated (UTC)
cc98-docs Ignored Ignored Preview Jul 27, 2026 4:05pm

@shellRaining shellRaining changed the title fix(api): 精确描述版面导航响应 fix(api): 精确描述版面概要响应 Jul 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant