技能 openapi-generator

📘

openapi-generator

Name: openapi-generator
Author: CuriousLearner

安全 🌐 網路存取⚙️ 外部命令

生成API的OpenAPI规范

手动创建API文档既耗时又容易出错。此技能可自动从代码和API生成全面的OpenAPI 3.0+规范。

支援: Claude Codex Code(CC)

⚠️ 67 差

下載技能 ZIP

在 Claude 中上傳

前往設定 → 功能 → 技能 → 上傳技能

開啟並開始使用

測試它

正在使用「openapi-generator」。为登录端点生成OpenAPI规范，该端点接受电子邮件和密码，返回访问令牌和刷新令牌。

預期結果:

✓ 创建了POST /auth/login端点
✓ 定义了包含电子邮件（格式：email）和密码（格式：password）的请求模式
✓ 添加了带令牌有效载荷的200响应模式
✓ 添加了401错误响应用于凭据无效的情况
✓ 配置了bearerAuth安全方案

安全審計

安全

v5 • 1/16/2026

This is a pure prompt-based documentation skill containing only instructions and examples for generating OpenAPI specifications. No executable code exists. All 110 static findings are false positives triggered by documentation patterns: example JWT tokens (HS256), OpenAPI security scheme names (bearerAuth), markdown code fences, and example URLs. Previous audit confirmed zero risk factors.

已掃描檔案

1,172

分析行數

發現項

審計總數

審計者: claude 查看審計歷史 →

品質評分

架構

100

可維護性

內容

社群

100

安全

規範符合性

你能建構什麼

记录REST API

从Express.js、FastAPI或Go代码生成全面的OpenAPI规范。

创建API参考指南

生成带示例和身份验证详细信息的标准化API文档。

验证API契约

确保OpenAPI规范在服务间保持合规和一致。

試試這些提示

基本生成

为我的REST API生成OpenAPI 3.0规范。这是我的Express.js路由代码：

从描述创建

为具有CRUD操作的用户管理API创建OpenAPI 3.0规范。

添加验证

验证此OpenAPI规范并建议改进以确保合规性：

多框架支持

为我的FastAPI端点和Pydantic模型生成OpenAPI文档。

最佳實務

提供完整的端点代码或详细描述以确保规范生成的准确性
在请求中包含身份验证要求和安全方案
指定响应状态码和错误模式以生成全面的文档

避免

要求技能执行代码或发起网络请求
期望在没有明确路径的情况下自动访问文件系统
请求技能部署或修改运行中的服务

常見問題

支持哪些编程语言？

支持Express.js、FastAPI、Go以及任何可以提供端点详情编程语言。

可以生成哪些OpenAPI版本？

支持生成OpenAPI 3.0、3.0.1、3.0.2、3.0.3和3.1规范。

可以与现有工具集成吗？

输出兼容Swagger UI、Stoplight Studio、Postman和ReadMe。

我的代码会被发送到任何地方吗？

不会。这是基于提示的技能，在您的AI会话中本地处理代码。

为什么我的规范验证失败？

常见问题包括缺少必需字段、无效的模式引用或错误的数据类型。

这与openapi-generator-cli有什么区别？

此技能使用AI生成规范；而CLI工具从现有规范生成客户端SDK。

開發者詳情

作者

CuriousLearner

授權

MIT

儲存庫

https://github.com/CuriousLearner/devkit/tree/main/skills/openapi-generator

引用

main

檔案結構

📄 SKILL.md