# Openapi Spec Generation

> 从代码、设计优先的规范和验证模式生成并维护 OpenAPI 3.1 规范。当用户要求创建 API 文档、生成 SDK 或确保 API 契约合规时使用。

- Skill: `kscz0000/openapi-spec-generation` (Agent Skill, multi-file: 2 files)
- Install (CLI): `npx skillmds@latest add kscz0000/openapi-spec-generation`
- Raw SKILL.md: https://api.skillmd.com/api/skills/kscz0000/openapi-spec-generation/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- Author: kscz0000 (https://skillmd.com/u/kscz0000)
- Updated: 2026-09-21
- Page: https://skillmd.com/skills/kscz0000/openapi-spec-generation

---


# OpenAPI 规范生成

用于创建、维护和验证 RESTful API 的 OpenAPI 3.1 规范的完整模式集合。

## 适用场景

- 从零创建 API 文档
- 从现有代码生成 OpenAPI 规范
- 设计 API 契约（设计优先方式）
- 根据规范验证 API 实现
- 从规范生成客户端 SDK
- 搭建 API 文档门户

## 不适用场景

- 任务与 OpenAPI 规范生成无关
- 需要本范围之外的其他领域或工具

## 使用说明

- 明确目标、约束和所需输入。
- 应用相关最佳实践并验证结果。
- 提供可执行的步骤和验证方法。
- 如需详细示例，请打开 `resources/implementation-playbook.md`。

## 资源

- `resources/implementation-playbook.md` 包含详细模式和示例。

## 局限性
- 仅在任务明确匹配上述范围时使用此技能。
- 输出结果不能替代针对特定环境的验证、测试或专家评审。
- 如果缺少必要的输入、权限、安全边界或成功标准，请停下来请求澄清。