api-documentation-generator
APIルートからOpenAPIドキュメントを生成
متاح أيضًا من: sickn33
APIドキュメントを手動で作成すると何時間もかかります。このスキルは、Express、FastAPI、NestJS、Flask、Railsのルートファイルを自動的に分析し、スキーマ、パラメータ、レスポンスを含む完全なOpenAPI 3.0仕様を生成します。
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "api-documentation-generator". Express APIルート用のOpenAPIドキュメントを生成
النتيجة المتوقعة:
- 3つのタグにわたる12のエンドポイントを含むopenapi.yamlを生成
- 作成されたスキーマ: User、CreateUserRequest、Product、Order
- 追加された認証スキーム: BearerAuth (JWT)とApiKeyAuth
- 含まれるエラーレスポンス: 400、401、404、500
- 保存先: /project/openapi.yaml
استخدام "api-documentation-generator". FastAPIバックエンド用のAPIドキュメントを作成
النتيجة المتوقعة:
- routes/users.pyとroutes/products.pyの8つのエンドポイントを分析
- UserResponse、ProductCreateのPydanticモデルを抽出
- ページネーションパラメータを含むOpenAPI 3.0仕様を生成
- 401と422のエラーレスポンス定義を追加
التدقيق الأمني
آمنThis is a prompt-based documentation skill with no executable code. It provides instructions for generating OpenAPI documentation and includes template files and examples. All static findings are false positives triggered by documentation patterns (HTTP method names, API endpoint syntax, and security concept references). No network access, no file system manipulation beyond normal AI operations, and no data collection.
عوامل الخطر
⚙️ الأوامر الخارجية (38)
🌐 الوصول إلى الشبكة (4)
درجة الجودة
ماذا يمكنك بناءه
REST APIのドキュメント化
Express、FastAPI、またはNestJSのルート定義からAPIコンシューマー向けにOpenAPI仕様を自動生成します。
APIリファレンスドキュメントの作成
手動で仕様を記述することなく、コードベースのルートファイルをSwagger UI対応のドキュメントに変換します。
API契約の生成
APIゲートウェイ設定と統合テスト用の標準化されたOpenAPI仕様を作成します。
جرّب هذه الموجهات
API Documentation Generatorスキルを使用して、Expressルートを分析し、プロジェクトルートにopenapi.yamlファイルを生成してください。
API Documentation Generatorスキルを使用して、FastAPIエンドポイントを読み取り、自動生成されたOpenAPIドキュメントに追加の例と詳細なエラーレスポンスを追加してください。
API Documentation Generatorを使用して、backendフォルダーのExpressルートとapiディレクトリのFlask APIを含むコードベース内のすべてのAPIルートを検索し、統合されたOpenAPI仕様を生成してください。
REST API用の包括的なOpenAPI 3.0ドキュメントを生成してください。検出されたすべてのエンドポイント、リクエスト/レスポンススキーマ、認証要件を含め、Users、Products、Ordersタグでグループ化してください。
أفضل الممارسات
- 新しいエンドポイントを追加した後にスキルを実行して、ドキュメントを最新の状態に保つ
- 公開前に生成されたスキーマを実際のAPIの動作と照らし合わせて確認する
- より詳細なエンドポイント説明のために、ルートにJSDocコメントまたはdocstringを追加する
تجنب
- レスポンスの正確性を検証せずに生成されたドキュメントを使用する
- 認証が必要なエンドポイントのセキュリティスキーム設定をスキップする
- ルートのソースファイルにアクセスせずにドキュメントを生成する