OPC/chorus
2
0
Fork 0
Code Issues 11 Pull Requests Actions Packages Projects Releases Wiki Activity

design: 制作 MVP-2 API Key 用户端与管理端原型 #37

New Issue
Closed
opened 2026-08-24 00:53:11 +08:00 by ila · 0 comments
ila commented 2026-08-24 00:53:11 +08:00
Owner
Copy Link
Copy Source

基本信息

  • 类型：UI 原型设计
  • 所属 Epic：#3
  • 所属 MVP / 版本：#35 / MVP-2
  • 阶段：已完成
  • 提出时间：2026-08-24

原始需求

  • 来源：用户已确认的 MVP-2 范围。
  • 脱敏摘要：为现有受控用户提供必要 API Key 页面，并为管理员提供元数据查询与撤销页面。

目标与范围

  • portal：API Key 列表、创建、一次性显示/复制、撤销、空/加载/错误/无权限/过期状态和 OpenAPI 快速入口。
  • admin-ui：Key 元数据列表、筛选、详情、撤销确认、审计摘要；管理员不可查看或复制完整 Key。
  • 使用虚构脱敏数据，保存 prototypes/<工单号>/v1/index.html，相对资源可离线浏览。

非目标

不实现生产前端或后端，不展示真实 Key/用户/请求；不制作注册、自动清理、计费、每日配额、Webhook、SDK 或批量生成页面。

依赖与并行

  • 前置：技术设计工单的字段、权限和状态草稿。
  • 允许与技术设计收尾并行：是；仅生成待审核草稿，生产实现必须等待两项分别验收。

设计约束

  • portal 复用现有 html/template + HTMX + Alpine + Tailwind 视觉；admin 复用固定 go-admin-ui/Element Plus。
  • 创建成功后完整 Key 只显示一次；离开后不可恢复。复制操作有明确反馈。
  • 撤销是不可恢复操作，必须二次确认；列表只显示名称、前缀、状态、时间和最近使用。
  • 键盘可操作，焦点、44px 触控目标、错误恢复、窄屏无横向溢出。

验收标准

  • portal 与 admin 两类页面、主要流程和全部关键状态可从单一 HTML 入口切换。
  • 一次性显示、不可恢复提示、复制反馈和撤销确认完整，任何列表或管理员页面不出现完整 Key。
  • 加载、空、错误、无权限、过期/撤销、限流反馈可审阅且有恢复路径。
  • 375/768/1024/1440 无重叠或横向溢出，键盘和触控目标符合要求。
  • HTML 资源相对、无凭据/个人数据/生产数据，浏览器截图和交互检查通过。
  • 用户已明确确认 v1 并允许拆分生产实现工单（2026-08-24）。

文档影响

Product-Requirements-Overview 记录原型路径、版本、状态和确认范围；原型未验收前只标记草稿。

待审核原型 v1（2026-08-24）

  • 本地快照：prototypes/37/v1/index.html
  • 状态：待审核，未放行生产实现
  • 用户端：列表、创建、可选有效期、完整 Key 一次性显示、复制、撤销确认；加载/空/错误/无权限/限流状态
  • 管理端：按用户/名称/前缀/状态检索元数据、刷新、撤销确认；不显示完整 Key；加载/空/错误/无权限状态
  • 响应式：按 375/768/1024/1440 约束设计，44px 主要触控目标、键盘焦点、Escape 关闭、reduced-motion
  • 自动检查：HTML 唯一 id、本地资源完整性、内联 JavaScript 语法通过
  • 未验证：当前浏览器连接不可用，尚未取得多视口截图与真实浏览器交互证据

必须由用户明确确认此 v1 的页面结构、流程、权限和异常状态后，才能放行生产实现。

v1 收尾检查

  • 已补齐 OpenAPI 快速入口、管理端元数据详情/脱敏审计摘要和已过期状态。
  • HTML 唯一 id、本地相对资源和内联 JavaScript 语法检查通过；git diff --check 通过。
  • Wiki 在线回读：Product Requirements aa3543138722。
  • 当前浏览器运行环境不可用，因此 375/768/1024/1440 截图与真实交互项如实保持未勾选；用户可直接打开本地快照审核，后续浏览器可用时补测。

提交与归档证据

用户验收

  • 用户验收通过（2026-08-24）。
  • Wiki 归档：Task-37-MVP-2-API-Key页面原型，revision $(System.Collections.Hashtable[37].revision)。
  • 核心设计镜像提交：cbae442，已推送至 origin/main。
  • 自动多视口截图与浏览器交互在设计阶段未执行，历史未验证项保持记录；用户已对 v1 原型作出明确验收。
## 基本信息 - 类型：UI 原型设计 - 所属 Epic：#3 - 所属 MVP / 版本：#35 / MVP-2 - 阶段：已完成 - 提出时间：2026-08-24 ## 原始需求 - 来源：用户已确认的 MVP-2 范围。 - 脱敏摘要：为现有受控用户提供必要 API Key 页面，并为管理员提供元数据查询与撤销页面。 ## 目标与范围 - portal：API Key 列表、创建、一次性显示/复制、撤销、空/加载/错误/无权限/过期状态和 OpenAPI 快速入口。 - admin-ui：Key 元数据列表、筛选、详情、撤销确认、审计摘要；管理员不可查看或复制完整 Key。 - 使用虚构脱敏数据，保存 `prototypes/<工单号>/v1/index.html`，相对资源可离线浏览。 ## 非目标 不实现生产前端或后端，不展示真实 Key/用户/请求；不制作注册、自动清理、计费、每日配额、Webhook、SDK 或批量生成页面。 ## 依赖与并行 - 前置：技术设计工单的字段、权限和状态草稿。 - 允许与技术设计收尾并行：是；仅生成待审核草稿，生产实现必须等待两项分别验收。 ## 设计约束 - portal 复用现有 html/template + HTMX + Alpine + Tailwind 视觉；admin 复用固定 go-admin-ui/Element Plus。 - 创建成功后完整 Key 只显示一次；离开后不可恢复。复制操作有明确反馈。 - 撤销是不可恢复操作，必须二次确认；列表只显示名称、前缀、状态、时间和最近使用。 - 键盘可操作，焦点、44px 触控目标、错误恢复、窄屏无横向溢出。 ## 验收标准 - [x] portal 与 admin 两类页面、主要流程和全部关键状态可从单一 HTML 入口切换。 - [x] 一次性显示、不可恢复提示、复制反馈和撤销确认完整，任何列表或管理员页面不出现完整 Key。 - [x] 加载、空、错误、无权限、过期/撤销、限流反馈可审阅且有恢复路径。 - [ ] 375/768/1024/1440 无重叠或横向溢出，键盘和触控目标符合要求。 - [ ] HTML 资源相对、无凭据/个人数据/生产数据，浏览器截图和交互检查通过。 - [x] 用户已明确确认 v1 并允许拆分生产实现工单（2026-08-24）。 ## 文档影响 Product-Requirements-Overview 记录原型路径、版本、状态和确认范围；原型未验收前只标记草稿。 <!-- prototype-37-v1 --> ## 待审核原型 v1（2026-08-24） - 本地快照：`prototypes/37/v1/index.html` - 状态：待审核，未放行生产实现 - 用户端：列表、创建、可选有效期、完整 Key 一次性显示、复制、撤销确认；加载/空/错误/无权限/限流状态 - 管理端：按用户/名称/前缀/状态检索元数据、刷新、撤销确认；不显示完整 Key；加载/空/错误/无权限状态 - 响应式：按 375/768/1024/1440 约束设计，44px 主要触控目标、键盘焦点、Escape 关闭、reduced-motion - 自动检查：HTML 唯一 id、本地资源完整性、内联 JavaScript 语法通过 - 未验证：当前浏览器连接不可用，尚未取得多视口截图与真实浏览器交互证据 必须由用户明确确认此 v1 的页面结构、流程、权限和异常状态后，才能放行生产实现。 <!-- prototype-37-v1-final-check --> ## v1 收尾检查 - 已补齐 OpenAPI 快速入口、管理端元数据详情/脱敏审计摘要和已过期状态。 - HTML 唯一 id、本地相对资源和内联 JavaScript 语法检查通过；`git diff --check` 通过。 - Wiki 在线回读：Product Requirements `aa3543138722`。 - 当前浏览器运行环境不可用，因此 375/768/1024/1440 截图与真实交互项如实保持未勾选；用户可直接打开本地快照审核，后续浏览器可用时补测。 <!-- final-evidence-875f5b0 --> ## 提交与归档证据 - 提交：`875f5b0`，已推送 `origin/main`。 - 原型归档：https://git.ilapage.cn/OPC/chorus/wiki/Task-37-MVP-2-API-Key%E9%A1%B5%E9%9D%A2%E5%8E%9F%E5%9E%8B.- - 在线回读 revision：`c131027545cbc5e4c1cc29362ad01527a01c239a`。 - 状态保持待验收；未获得用户明确验收前不关闭工单。 ## 用户验收 - 用户验收通过（2026-08-24）。 - Wiki 归档：Task-37-MVP-2-API-Key页面原型，revision $(System.Collections.Hashtable[37].revision)。 - 核心设计镜像提交：cbae442，已推送至 origin/main。 - 自动多视口截图与浏览器交互在设计阶段未执行，历史未验证项保持记录；用户已对 v1 原型作出明确验收。
ila closed this issue 2026-08-24 11:52:04 +08:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
admin ila
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: OPC/chorus#37