specs-api
Installation
SKILL.md
specs-api
接口定义:从产品原型与业务流程生成接口文档。
前置依赖(先检查,缺失就停)
- 必须存在:
docs/product/business-flow.md、docs/product/demo/(≥1 个 HTML 页面)。 - 建议存在:
docs/specs/data/下的 DB 设计文件(MySQL/SQLite/PostgreSQL 为table.sql,MongoDB 为schema.json;接口字段名/类型优先对齐它,缺失则退化为用 glossary 英文名)、docs/product/glossary.md。 - 缺失必选项时,提示先运行对应 skill,结束。
Step 1 — 选协议(AskUserQuestion)
- HTTP(默认推荐):OpenAPI 3.0,输出
docs/specs/API/模块.yaml - gRPC:proto3,输出
docs/specs/grpc/模块.proto
选 HTTP 则进入 Step 2 选风格;选 gRPC 直接跳到 Step 5。
HTTP 与 gRPC 是互斥路径,只走一条:选 HTTP → 只执行 Step 2/3/4,到 Step 4 结束;选 gRPC → 只执行 Step 5,到 Step 5 结束。严禁在完成所选路径后继续执行另一条(HTTP 路径不得接着跑 Step 5;反之亦然)。