api-doc-generator
ソースコードからOpenAPI 3.0ドキュメントを生成
APIドキュメントを手作業で書くのは時間がかかり、不完全になりがちです。このスキルは、コードから直接OpenAPI 3.0仕様、リクエスト例、Postmanコレクションを自動生成するため、チームは常に正確なAPIドキュメントを利用できます。
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
Agent向けリソース
AI Agent、クローラー、またはスクリプトがページ全体ではなくクリーンなコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「api-doc-generator」を使用しています。 Express route: GET /users/:id は { id, name, email } を返し、ステータスは 200 または 404
期待される結果:
GET /users/{id} をドキュメント化したOpenAPI 3.0 YAML。パスパラメータスキーマ、id (integer)、name (string)、email (string) を含む成功レスポンススキーマ、および404エラーレスポンス定義を含む
「api-doc-generator」を使用しています。 { productId, quantity, shippingAddress } を受け取り、{ orderId, status, total } を返す POST /orders エンドポイント
期待される結果:
必須フィールド付きの完全なリクエスト本文スキーマ、注文確認の詳細を含むレスポンススキーマ、サンプルJSONペイロード付きのすぐ使えるPostmanコレクションエントリ
「api-doc-generator」を使用しています。 この内部APIドキュメントを公開向けのOpenAPIリファレンスにリファクタリングしてください
期待される結果:
セキュリティスキーム定義、レート制限ドキュメント、バージョニングヘッダー、公開開発者ポータルに適したMarkdown形式のエンドポイント説明を含む、整理されたOpenAPI仕様
セキュリティ監査
安全Two static analysis findings evaluated and dismissed as false positives. The 'weak cryptographic algorithm' alert on SKILL.md:4 is a YAML description field with no cryptography. The 'high file entropy' alert is caused by CJK/Chinese UTF-8 characters, which naturally have higher entropy than ASCII text. No actual security threats found: no network access, no filesystem operations, no external commands, no scripts, no environment variable access, and no prompt injection attempts detected.
検出されたパターン
品質スコア
作れるもの
バックエンドコードからAPIドキュメントを自動生成
バックエンド開発者がルートハンドラーやコントローラーファイルを貼り付けると、チームで利用できる完全なOpenAPI 3.0仕様ドキュメントを受け取れます。
オンボーディング用のPostmanコレクションを作成
フロントエンド開発者や新しいチームメンバーは、サンプルリクエスト付きのインポート可能なPostmanコレクションを入手し、すぐにAPIを探索してテストできます。
チーム間でAPIドキュメントを標準化
エンジニアリングリードはこのスキルを使用して、マイクロサービス全体で一貫したOpenAPIドキュメントを徹底し、すべてのAPIが同じ仕様形式に従うようにできます。
これらのプロンプトを試す
このExpressルートハンドラーのAPIドキュメントを生成してください。HTTPメソッド、パス、リクエストパラメータ、レスポンス形式を含めてください。
このREST APIコントローラーの完全なOpenAPI 3.0 YAML仕様を作成してください。すべてのエンドポイント、リクエストスキーマ、レスポンススキーマ、エラーコードを含めてください。
このAPI定義からPostmanコレクションJSONを生成してください。各エンドポイントの認可ヘッダー、リクエスト本文の例、テストスクリプトを含めてください。
Python、Java、TypeScriptで書かれたこれらのソースファイルからAPI定義を抽出してください。一貫した命名と例を備えた統一OpenAPI 3.0仕様を生成してください。
ベストプラクティス
- 最も包括的なドキュメント出力を得るために、すべてのルートとハンドラーを含む完全なソースコードファイルを提供してください
- 生成されたOpenAPI仕様は必ず正確性をレビューし、コードだけでは表現できないビジネスロジックの詳細を追加してください
- より充実したAPIドキュメントを生成するために、サンプルリクエストペイロードと期待されるレスポンスデータをプロンプトに含めてください
回避
- ドキュメント生成を依頼する際に、APIキー、トークン、シークレットを含むソースコードを貼り付けないでください
- 生成されたAPIドキュメントは、エンドポイントの説明とスキーマをレビューして修正する前に公開しないでください
- 外部API利用者に公開すべきではない内部専用または非推奨のエンドポイントをドキュメント化することは避けてください