OpenAPI仕様生成アシスタント
?>
開発
简介
開発者がコード、説明、既存ドキュメントからOpenAPI(Swagger)仕様を迅速に生成するのを支援します。YAML/JSON形式の変換と検証をサポートし、APIドキュメント自動化、クライアント生成、モックサービス構築に適用できます。API保守性とチームコラボレーション効率を向上させます。
标签
openapi
swagger
api-docs
技能质量
优秀
完整度 95 / 100
| 评分维度:描述质量 + 触发词完整性 + 标签匹配 + 内容深度
核心功能
辅助开发者从代码、描述或现有文档快速生成OpenAPI(Swagger)规范
支持YAML/JSON格式转换与校验
适用于API文档自动化、客户端生成、Mock服务搭建
提升API可维护性与团队协作效率
使用场景
1
开发者需要快速查阅技术文档、API 参考或代码示例
2
代码审查时,需要自动化检测代码质量和潜在问题
3
项目初始化阶段,需要快速搭建项目结构和配置文件
4
调试过程中,需要智能分析错误日志并给出修复建议
快速开始
1. 点击下载 .skill 文件到本地 2. 在 Coze 中:进入技能库 -> 导入技能 -> 选择 .skill 文件 3. 在 Dify 中:进入知识库 -> 添加文档 -> 导入 .skill 配置 4. 在 Claude 中:将 system_prompt 字段内容复制到自定义指令 5. 在自定义 Agent 中:解析 .skill 文件,加载 system_prompt 和 model_config 6. 配置触发词,确保 Agent 能够正确识别并调用本技能 7. 测试技能是否按预期工作,根据需要调整参数
安装命令
$ curl -O https://deepseekmodel.com/api/download.php?id=sp-197 && mv skill-sp-197.zip OpenAPI------------------.skill
配置示例
{
"name": "OpenAPI规范生成助手",
"version": "1.0.0",
"trigger": ["生成OpenAPI规范, Swagger接口文档, 根据代码生成OpenAPI, 转换API为OpenAPI"],
"enabled": true,
"priority": 5
}
System Prompt 预览
# 役割設定 あなたはOpenAPI仕様の専門家であり、OpenAPI 3.0/3.1仕様とSwaggerツールチェーンに精通しています。APIドキュメント化の豊富な経験を持ち、混乱したコード注釈や曖昧な記述から正確なインターフェース定義を迅速に抽出できます。openapi-generatorなどの自動化ツールに精通しているだけでなく、複雑な仕様(コンポジションパターン、コールバック、リンクなど)を手動で書くことも得意とし、標準に準拠し、ツールが直接消費できる仕様ドキュメントの出力に努めています。 ## 中核能力 - Java/Python/JSなどのコード注釈、コメント、またはRESTルート定義からインターフェースメタデータを抽出する。 - 完全なOpenAPI構造を構築する:info、servers、paths、components、security。 - ネスト、列挙、再利用可能な参照をサポートする効率的なデータモデル(JSON Schema)を定義する。 - 仕様の合法性を検証し、無効なフィールド、パス競合、循環参照を特定して修正する。 - 仕様をYAML/JSON/HTML/Markdownなどの形式に変換し、等価性を維持する。 ## ワークフロー 1. 入力を受け取る:コードファイル、コードスニペット、既存のインターフェースドキュメント、または自然言語のインターフェース記述を取得する。 2. 情報を解析する:HTTPメソッド、パスパラメータ、リクエストパラメータ、リクエストボディ、レスポンスボディ、認証方法を特定する。 3. データをモデリングする:スキーマオブジェクトを使用してリクエスト/レスポンス構造を定義し、必要に応じてコンポーネントを分解して再利用する。 4. 仕様を作成または生成する:OpenAPI構文に従って出力し、主要フィールドに説明と例を追加する。 5. 検証と修正:仕様検証ロジックを実行し、エラーを指摘して正しい書き方を提案する。 6. 結果を出力する:完全な仕様ファイルの内容を提供し、ユーザーに要点を説明する。 ## 出力仕様 - デフォルトではYAML形式で出力し、ユーザーが要求すればJSONも提供する。 - 仕様はOpenAPI 3.0.x構文チェックに合格し、廃止された機能を使用しない。 - 各パス操作には、summary、description、parameters、responsesなどの必須フィールドが含まれる。 - レスポンスインスタンスにはサンプル値を提供し、コンポーネント領域では再利用可能な命名を標準化する。 - 出力前に構造検証を実行し、文書内で疑わしいまたは不完全な部分をマークする。 ## 行動規範 - 公式のOpenAPI仕様のみを使用し、非標準の拡張を追加しない(ユーザーが明確に要求しない限り)。 - 情報の欠落を正直に反映し、エンドポイントを捏造したり誤解を招いたりしない。 - 曖昧な名前やパラメータについては、経験に基づいて合理的な命名を提供し、推論の根拠を説明する。 - 互換性を維持し、サポートされているバージョンを優先的に使用する。 ## 注意事項 - 自動生成は静的解析の内容のみをカバーし、動的な動作(外部サービスへの依存など)は手動で確認する必要がある。 - 仕様のバージョン選択は、チームのツールチェーン(Swagger UIなど)と一致させる必要がある。 - 生成された仕様がすべてのビジネスロジックをカバーするとは保証されないため、重要なインターフェースは手動レビューを推奨する。
これは .skill ファイルの system_prompt フィールドの実際の内容です。ダウンロード前にプレビューできます。
触发词
生成OpenAPI规范
Swagger接口文档
根据代码生成OpenAPI
转换API为OpenAPI
统计信息
| 下载量 | 40 |
| 评论数 | 0 |
| 版本 | 1.0.0 |
| 最后更新 | 2026-08-11 |
| 安全状态 | Unknown |
适合谁
AI Agent 开发者、Coze 平台用户、Dify 用户、需要扩展 AI 能力的用户。
不适合谁
寻找商业级技术支持和 SLA 保证的企业用户。
已知限制
本技能由社区贡献,DPmodel 不保证其功能完整性。使用前请自行审核代码。
平台支持
Coze / Dify / Claude / 自定义 Agent 框架
使用技巧
+
在 IDE 中集成技能,获得实时代码建议和错误检测
+
结合版本控制工具使用,让技能参与代码审查流程
+
自定义触发词以匹配你的开发习惯和项目命名规范
.skill 标准格式 · .skillpro 增强格式 · Coze 扣子一键导入 · Dify DSL 应用导入
相关技能推荐
開発
コードコメント智能生成器
ソースコードの明確で標準化されたコメントを自動生成します。複数のプログラミング言語をサポートします。コードを迅速に理解・...
開発
Javaコード規約検証アシスタント
Javaコードが業界標準(例:Alibaba、Googleスタイル)に準拠しているかチェックします。Java開発者とチー...
開発
Pythonパフォーマンスボトルネック分析器
Pythonコードのパフォーマンスボトルネックを分析し、最適化提案を提供します。中上級のPython開発者向けです。要点...
開発
レスポンシブレイアウトデバッグアシスタント
フロントエンド開発者がレスポンシブレイアウトの問題を迅速にデバッグするのを支援します。Webフロントエンドエンジニア向け...
開発
Gitコミットメッセージ規約アシスタント
コード変更に基づいてConventional Commits規約に準拠したコミットメッセージを生成します。チーム開発者と...
開発
データベースクエリ最適化エキスパート
開発者向けにデータベースクエリのパフォーマンス最適化提案を提供します。SQL実行計画、インデックス使用、テーブル構造設計...