スキル API Documenter
📝
API Documenter
安全
API ドキュメントを生成
開発者は API ドキュメントの手動作成に何時間も費やしています。このスキルは、コードや OpenAPI 仕様から包括的な API ドキュメントを自動生成し、時間を節約し、一貫性を確保します。
対応: Claude Codex Code(CC)
1
スキルZIPをダウンロード
2
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
3
オンにして利用開始
テストする
「API Documenter」を使用しています。 ユーザープロフィールデータを返す GET /users/{id} エンドポイントの API ドキュメントを生成
期待される結果:
- # GET /users/{id}
- ユニーク識別子でユーザープロフィールを取得します。
- ## リクエスト
- - メソッド：GET
- - パス：/users/{id}
- - 認証：Bearer トークンが必要
- ## レスポンス 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
「API Documenter」を使用しています。 ペット API の OpenAPI 仕様を文書化
期待される結果:
- # Pet Store API
- ## 概要
- ペット在庫管理のための RESTful API。
- ## エンドポイント
- - GET /pets - ペット一覧を取得
- - POST /pets - ペットを追加
- - GET /pets/{id} - ペットを取得
- - DELETE /pets/{id} - ペットを削除
セキュリティ監査
安全v1 • 2/24/2026
This is a prompt-only skill that generates API documentation. Static analysis found no executable code, no network requests, no filesystem access, and no external command execution. The skill contains only natural language prompts for generating documentation content.
0
スキャンされたファイル
0
解析された行数
0
検出結果
1
総監査数
セキュリティ問題は見つかりませんでした
監査者: claude
品質スコア
38
アーキテクチャ
100
保守性
85
コンテンツ
31
コミュニティ
100
セキュリティ
74
仕様準拠
作れるもの
内部サービス向けクイック API ドキュメント
開発スプリント中に内部マイクロサービス用のドキュメントを迅速に生成
パブリック API ドキュメント
公開 API 製品向けのユーザー向けドキュメントを作成
レガシー API ドキュメントの復元
コードを分析して文書化されていないレガシー API のドキュメントを生成
これらのプロンプトを試す
基本的なドキュメントリクエスト
Generate API documentation for the following endpoint: [paste endpoint code or description]
完全な API ドキュメント
Create comprehensive API documentation for this OpenAPI specification: [paste OpenAPI JSON/YAML]
複数言語の例
Generate API documentation with code examples in Python, JavaScript, and curl for: [paste endpoint details]
Markdown ドキュメント
Create polished markdown API documentation with sections for overview, endpoints, authentication, error codes, and examples: [paste API specification]
ベストプラクティス
- 最適な結果を得るには完全な OpenAPI 仕様を提供してください
- 入力に認証の詳細を含めてください
- 公開前に生成された例の正確性を確認してください
回避
- API エンドポイントのライブテストを期待すること
- 不完全または曖昧なエンドポイントの説明を提供すること
- スキルが特定の内部規約を理解していると想定すること
よくある質問
このスキルはどのような入力形式を受け付けますか？
このスキルは JSON または YAML 形式の OpenAPI 仕様と、API エンドポイントの自然言語記述の両方を受け付けます。
このスキルは API エンドポイントをテストできますか？
いいえ、このスキルはドキュメント生成のみを行います。エンドポイントをテストするための実際の HTTP リクエストは実行できません。
コード例ではどのプログラミング言語がサポートされていますか？
このスキルは JavaScript、Python、curl、Ruby、Go、およびその他の一般的な言語での例を生成できます。
GraphQL API で動作しますか？
現在は REST API に焦点を当てています。GraphQL のサポートは将来のバージョンで追加される可能性があります。
生成されたドキュメントの正確性はどのくらいですか？
正確性は入力仕様の完全性に依存します。完全な OpenAPI 仕様から最も正確なドキュメントが生成されます。
出力形式をカスタマイズできますか？
はい、プロンプトで markdown、HTML、その他の形式を指定できます。デフォルトの出力形式は markdown です。