このスキルは、OpenAPI仕様、インタラクティブなSwagger UI、コード例、RESTおよびGraphQL APIのリファレンスガイドを使用して、プロフェッショナルなAPIドキュメントを作成するのに役立ちます。
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「api-documentation」を使用しています。 ユーザー管理APIのOpenAPI仕様を作成
期待される結果:
/usersエンドポイント、ページネーション、認証、レスポンススキーマを含む完全なOpenAPI 3.0仕様
「api-documentation」を使用しています。 認証フローをドキュメント化
期待される結果:
ステップバイステップガイド：1. ログインエンドポイントはJWTを返す、2. AuthorizationヘッダーにBearerトークンを含める、3. トークン更新メカニズム、4. curlコマンド例
「api-documentation」を使用しています。 APIリファレンス構造を定義
期待される結果:
整理されたドキュメント：概要、認証、リソースごとにグループ化されたエンドポイント、エラーコード、レート制限、変更履歴
セキュリティ監査
安全All 79 static findings are false positives. The skill contains only documentation templates with example URLs and code blocks. No actual shell commands, network exfiltration, or cryptographic vulnerabilities exist. The scanner triggered on markdown code delimiters, placeholder URLs in examples, and JWT authentication mentions in OpenAPI specs.
品質スコア
作れるもの
内部API開発
フロントエンドとバックエンドのチームコラボレーションのために、内部マイクロサービスAPIをドキュメント化
公開APIリリース
外部開発者がAPIを使用するためのプロフェッショナルなドキュメントを作成
SDKドキュメント
ライブラリ利用者のための包括的なガイドとリファレンスドキュメントを生成
これらのプロンプトを試す
ユーザーを管理するREST APIエンドポイントのOpenAPI 3.0仕様を作成します。GET（リスト）、POST（作成）、GET by ID、PUT（更新）、DELETEエンドポイントを含めます。適切なHTTPステータスコードでリクエスト/レスポンススキーマを定義します。
JWT認証が必要な保護されたAPIエンドポイントをドキュメント化します。認証フロー、Bearerトークンの使用、401/403エラーレスポンス、認証済みリクエストのcurlコマンド例を含めます。
REST APIの包括的なエラーハンドリングガイドを作成します。一般的なエラーコード（400、401、403、404、409、429、500）、その意味、エラーレスポンスの例、および推奨されるクライアントハンドリングアプローチをドキュメント化します。
Express.js API用にSwagger UIをセットアップします。swagger-ui-expressの統合方法、OpenAPI YAMLファイルの読み込み、カスタムCSSの設定、/api-docsへのドキュメントのマウント 방법을を示します。
ベストプラクティス
- 複数の言語（JavaScript、Python、curl）で動作するコード例を提供する
- 成功とエラーの両方のレスポンスケースを例と一緒に常にドキュメント化する
- 変更履歴を使用してAPIの変更とドキュメントを同期させる
回避
- 例のコードに実際のAPIキーまたはパスワードを使用する
- 「データを返す」のような曖昧な説明を残しておく
- 障害シナリオのエラーケース документацияを忘れる