Files

duanshuwen e8eb8614f0 docs: 清理过时文档并更新管理端名称

删除home-api.md、team-building-api.md等废弃文档
统一替换所有文档中的`WonderQ-Admin-UI`为`WonderQ-Admin-UI-Vue`
更新README.md与联调文档的内容与路径
修正各API文档的过时描述，移除废弃的迁移说明与本地mock依赖
整理docs/README.md的文档索引，优化阅读路径

2026-08-26 19:41:15 +08:00

2.2 KiB

Raw Blame History

页面模块配置 API 契约

本文档补充 WonderQ-Admin 和 WonderQ-Admin-UI-Vue 对站点页面模块的维护约定。接口路径保持现有实现不变，所有 JSON 响应遵循三端统一 API 响应契约。

接口清单

除登录接口外，所有接口需要 Authorization: Bearer <admin-jwt>。

方法	路径	说明
`GET`	`/api/admin/site-config`	获取全部模块和停用记录
`POST`	`/api/admin/site-config/{module}`	新增模块项，成功 `201`
`PATCH`	`/api/admin/site-config/{module}/{id}`	更新模块项
`DELETE`	`/api/admin/site-config/{module}/{id}`	删除模块项
`PATCH`	`/api/admin/site-config/{module}/reorder`	按完整 ID 列表排序

允许的 module：heroSlides、destinationHero、demandHero、demandFeatureCards、demandForm、vehicleOptions、vehicleService。

响应约定

列表、详情、删除和排序的业务字段放在 data 内：

{
  "code": 200,
  "msg": "success",
  "data": {
    "heroSlides": [],
    "destinationHero": [],
    "demandHero": [],
    "demandFeatureCards": [],
    "demandForm": [],
    "vehicleOptions": [],
    "vehicleService": []
  }
}

创建接口返回：

{
  "code": 201,
  "msg": "success",
  "data": {
    "id": "module-item-001"
  }
}

排序请求必须提交当前模块的完整 itemIds，不能重复；成功返回 data: { "items": [] }。删除成功返回 data: { "id": "..." }。参数错误、资源不存在和服务异常分别使用统一契约的 400、404 和 500 响应。

字段边界

GET 返回启用和停用的完整记录，前端负责显示状态。
sortOrder 为从 0 开始的非负整数，后端负责重新规范化。
图片字段保存最终 HTTP(S) URL，不接受 base64。
demandForm 为单例模块，不执行无意义的排序。
vehicleService 为单例用车服务配置，不支持排序；serviceSections、processSteps 使用 {title, description} 数组，advantages 使用字符串数组。
站点模块只负责站点配置；首页内容、玩法、详情、管家和客片案例使用各自领域文档。

2.2 KiB Raw Blame History Unescape Escape

页面模块配置 API 契约

接口清单

响应约定

字段边界

2.2 KiB

Raw Blame History