openapi-spec-generation 是帮助 AI 创建和维护 OpenAPI 3.1 接口规范的 Skill。它适合后端开发者和 API 团队,把路径、请求参数、返回结构与认证要求写成机器和人都能读取的契约。
接口协作中,正常返回常常有示例,失败情况却要临时问:“没权限是什么状态码?找不到数据返回空数组还是空值?”这份 Skill 把错误说明、认证方式和空值语义都列进检查范围。
已有接口,可以从代码整理规范;新接口,则可以先写契约再实现;持续演进的项目,也可以在代码上补注解并生成规格。选哪种方式,要看当前项目的起点。
它建议复用公共的数据结构、参数和响应定义,避免几个接口把同一个对象写成不同形状。具体示例也比“返回用户信息”这样的泛描述更能帮助调用方理解。
你提供当前实现或接口草案,以及已有文档规则,就可以让 AI 补出可维护的规范。之后它可用于文档展示、客户端生成或实现校验,但这些环节仍要配合项目里的相应工具。