使用设��优先、代码优先或混合方法为 REST API 创建全面的 OpenAPI 3.1 规范。包括模板、验证模式和 SDK 生成指南。
下载技能 ZIP
在 Claude 中上传
前往 设置 → 功能 → 技能 → 上传技能
开启并开始使用
测试它
正在使用“openapi-spec-generation”。 为用户 API 创建 OpenAPI 3.1 规范
预期结果:
完整的 OpenAPI 规范，包含 /users 端点（GET、POST）、/users/{id} 端点（GET、PATCH、DELETE）、User 模式（包含 uuid、email、name、status、role 字段）、Bearer 身份验证、分页参数和标准错误响应。
正在使用“openapi-spec-generation”。 向响应添加速率限制标头
预期结果:
更新的规范，包含 RateLimited 响应，包括 Retry-After、X-RateLimit-Limit 和 X-RateLimit-Remaining 标头及其整数模式。
正在使用“openapi-spec-generation”。 从规范生成 TypeScript 客户端
预期结果:
TypeScript fetch 客户端，具有每个端点的类型化方法、适当的身份验证标头，以及与模式匹配的 TypeScript 接口。
安全审计
安全This skill provides instructional documentation for OpenAPI specification generation. All static findings are false positives: shell command examples are documentation samples, hardcoded URLs are example domains (example.com, localhost), JWT references are standard API authentication definitions, and there is no malicious code execution. The skill is safe for marketplace publication.
中风险问题 (1)
低风险问题 (2)
质量评分
你能构建什么
新 API 设计
使用设计优先方法为新 API 创建 OpenAPI 规范，为身份验证、分页和错误处理提供全面的示例。
现有 API 文档
使用 FastAPI 或 Express 与 tsoa 注释从现有代码库生成文档。
SDK 生成工作流
从 OpenAPI 规范生成多种语言的客户端 SDK，供前端和外部消费者使用。
试试这些提示
为具有 CRUD 操作的 [RESOURCE] API 创建 OpenAPI 3.1 规范。包括通过 Bearer 令牌的身份验证、分页支持和标准错误响应。
向现有 OpenAPI 规范添加 JWT Bearer 身份验证和 API 密钥安全方案。包括 401 和 403 错误响应。
从此 OpenAPI 规范生成 Python 客���端 SDK。包括身份验证处理和适当的错误类型。
为此 OpenAPI 规范创建 Spectral linting 规则，强制执行操作 ID、要求描述并验证安全定义。
最佳实践
- 使用 $ref 在整个规范中重用模式、参数和响应
- 在规范中包含真实示例以帮助 API 消费者
- 定义所有可能的错误代码并包含描述性消息
- 在 URL 路径中对 API 进行版本控制，并对规范更改使用语义版本控制
避免
- 避免通用描述，如"获取资源"——明确说明返回的内容
- 不要跳过安全定义——每个端点都应记录身份验证
- 不要混合命名约定——在整个过程中保持 camelCase 或 snake_case 的一致性