Agent Skills
返回列表
Swagger 页面生成

Swagger 页面生成

开发编程 更新于 2026.08.29

将以下提示词粘贴到你的 AI 对话框中:

请根据 https://skillhub.cn/install/skillhub.md,安装 @user_fc08a06f/swagger-page-gen。

技能介绍

要解决什么问题

后端已经有一份 Swagger/OpenAPI 描述,但管理端 CRUD 页面往往还要手写列表、表单、字段映射和 API 封装。接口一多,重复劳动和前后端字段不一致都会拖慢迭代。

Swagger Page Gen 把「接口文档 → 可维护页面代码」做成一条可复用的生成链路:先对齐数据契约与项目约定,再按 Swagger 解析出 PageSchema,最后落到你选的 UI 库组件上。

技能如何工作

生成前有一套固定的读取顺序,避免跳过基础约束:

  1. 先读 foundation/page-schema.md、coding-conventions.md、api-contract.md,明确页面数据契约、编码风格和 API 层规范。
  2. 读项目根目录的 .page-gen.yml(人工维护的初始配置),并立即执行 foundation/config-validator.md,产出 .page-gen.lock.yml。
  3. 后续生成与 QA 只认 lock 文件里 verified 节(例如 verified.tech.ui_library),再加载对应 adapter/*.md 与任务文档(如 workflow/swagger-to-crud.md)。

两种用法:

  • 一键生成:按 workflow/swagger-to-crud.md,提供 Swagger JSON 或 URL。
  • 分步生成:domain/swagger-analyzer.md 确认 PageSchema → domain/crud-*.md 搭页面结构 → adapter/*.md 写出具体 UI 代码。

| 文件 | 角色 |
|------|------|
| .page-gen.yml | 你填写的初始配置,可能与仓库现状有偏差 |
| .page-gen.lock.yml | 校验后的可信快照,生成与 QA 的唯一依据 |

适用边界与注意点

  • 没有 .page-gen.yml 时,技能无法按项目约定生成;配置只需填一次,但改技术栈或目录结构后应重新校验。
  • 初始 yml 与真实项目不一致时,以 lock 为准,避免生成代码引用不存在的路径或 UI 库。
  • 建议将 .page-gen.lock.yml 纳入版本控制,方便团队共享「已验证」的配置状态。

使用场景

  • 后端已导出 Swagger JSON,要在现有管理端项目里按 PageSchema 生成列表与表单页
  • 拿到 OpenAPI 文档 URL,希望走 swagger-to-crud 工作流一次性产出页面骨架与 adapter 组件
  • 接口字段改版后,先跑配置校验更新 `.page-gen.lock.yml`,再按 lock 中的 UI 库重新生成 CRUD
  • 新项目在根目录写好 `.page-gen.yml`,用分步流程先解析接口确认 Schema 再落地具体 UI

适合人员

  • 负责内部管理后台、习惯以 Swagger 为唯一接口真相源的全栈工程师
  • 需要把团队技术栈(UI 库、目录规范)写进 yml 并用 lock 文件约束 AI 生成结果的技术负责人
  • 从后端拿到 OpenAPI 后、要按项目 api-contract 生成 API 层与页面而非手写表单的前端开发
  • 维护多服务接口文档、希望配置校验后再批量生成 CRUD 以保持一致性的平台或 BFF 开发者