swagger-doc-creator について
Swaggerドキュメント作成を中心とするAPI開発向けスキルです。手順に沿った案内やコード・設定の生成を行い、一般的な標準に照らして出力を検証します。
主な機能
- 01Swagger作成の段階的な案内
- 02コードと設定の生成
- 03一般的な標準に基づく検証
- 04REST・GraphQL・OpenAPIに対応
活用シーン
- 01Swaggerドキュメントの作成
- 02API設定の生成
- 03API開発パターンの確認
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/swagger-doc-creatorを入力して読み込まれたか確認します。
詳細
Swagger ドキュメント作成ツール
概要
このスキルは、API 開発分野における Swagger ドキュメント作成タスクを自動で支援します。
使用するタイミング
以下の場合、このスキルが自動的に有効になります。
- リクエストで「swagger doc creator」と言及した場合
- Swagger ドキュメント作成のパターンやベストプラクティスについて質問した場合
- REST、GraphQL、OpenAPI、認証、API 設計パターンを網羅する API 開発スキルの支援が必要な場合
手順
- Swagger ドキュメント作成について、段階的に案内します
- 業界のベストプラクティスとパターンに従います
- 本番環境で使用できるコードと設定を生成します
- 一般的な標準に照らして出力を検証します
例
使用例：基本的な使い方 リクエスト：「Swagger ドキュメント作成を手伝ってください」 結果：段階的に案内し、適切な設定を生成します
前提条件
- 関連する開発環境が設定されていること
- 必要なツールとサービスを利用できること
- API 開発の概念を基本的に理解していること
出力
- 生成された設定とコード
- ベストプラクティスの推奨事項
- 検証結果
エラー処理
| エラー | 原因 | 解決策 |
|---|---|---|
| 設定が無効です | 必須フィールドが不足しています | 必須パラメーターについてドキュメントを確認してください |
| ツールが見つかりません | 依存関係がインストールされていません | 前提条件に従って必要なツールをインストールしてください |
| アクセスが拒否されました | アクセス権限が不足しています | 認証情報とアクセス権限を確認してください |
リソース
- 関連ツールの公式ドキュメント
- ベストプラクティスガイド
- コミュニティの例とチュートリアル
関連スキル
API 開発スキルカテゴリの一部です。 タグ：api、rest、graphql、openapi、swagger
コメント
Markdown 対応