bruno-api
إنشاء وثائق API من ملفات اختبار Bruno
تتقادم وثائق API اليدوية بسرعة ونادراً ما تلتقط تفاصيل المصادقة والأذونات وتصفية المستأجرين المتعددين. تنشئ هذه الأداة وثائق شاملة ودقيقة عن طريق تحليل ملفات اختبار Bruno وربطها بتنفيذ Django الخلفي مع مراجع الكود المرقمة حسب رقم السطر.
スキルZIPをダウンロード
Claudeでアップロード
設定 → 機能 → スキル → スキルをアップロードへ移動
オンにして利用開始
テストする
「bruno-api」を使用しています。 Generate documentation for api-tests/auth/login.bru
期待される結果:
Generated comprehensive documentation for POST /api/v2/auth/login including JWT authentication flow, request schema (email, password), response structure (token, user object), DRF view implementation at dashboardapp/views/v2/auth.py:45, serializer validation rules, error cases (401, 400), and React Query hook example with TypeScript types.
「bruno-api」を使用しています。 Analyze api-tests/users/list-users.bru with --dry-run
期待される結果:
Analysis plan: GET /api/v2/users endpoint with JWT auth required. Will search dashboardapp/v2_urls.py for route, expect DRF ViewSet with pagination, company-scoped filtering, and UserSerializer. Documentation will include query parameters (page, search, role), permission classes, multi-tenant queryset filtering, and response pagination structure.
「bruno-api」を使用しています。 Scan api-tests/v2/ and generate documentation
期待される結果:
Processed 12 Bruno files. Generated documentation for endpoints: auth/login, auth/refresh, users/list, users/create, users/update, projects/list, projects/detail, tasks/create, tasks/update, webhooks/configure, settings/update, billing/subscription. Each includes full request/response schemas, authentication details, implementation references, and testing examples. Total documentation: 8,500 words across 12 endpoint sections.
セキュリティ監査
安全This skill is a documentation generator for Bruno API test files. All 56 static findings are false positives: C2 keywords and weak crypto patterns are markdown formatting artifacts, shell backticks are inline code syntax in documentation, and the hardcoded URL is the GitHub source reference. The skill uses only Read, Edit, Glob, Grep, and Bash tools for legitimate documentation generation purposes.
品質スコア
作れるもの
سير عمل توثيق مطور الواجهة الخلفية
يضيف مطور الواجهة الخلفية نقطة نهاية API جديدة مع اختبارات Bruno ويحتاج إلى إنشاء وثائق شاملة لفريق الواجهة الأمامية. يقوم بتشغيل الأداة مع مسار ملف Bruno لإنشاء الوثائق تلقائياً بما في ذلك أنواع TypeScript و React Query hooks وأمثلة الاختبار.
تدقيق API ونقل المعرفة
يحتاج قائد الفريق إلى توثيق نقاط نهاية API الموجودة لأعضاء الفريق الجدد أو الشركاء الخارجيين. يستخدمون وضع المسح لمعالجة جميع ملفات Bruno في دليل ما، وإنشاء مرجع API كامل مع تفاصيل المصادقة والأذونات ومنطق الأعمال.
تخطيط تكامل الواجهة الأمامية
يحتاج مطور الواجهة الأمامية إلى فهم كيفية التكامل مع نقطة نهاية API الخلفية. ينشئ الوثائق من ملف Bruno لرؤية أنواع TypeScript المحددة ومخططات الطلب/الاستجابة وحالات الأخطاء وأمثلة React Query hook.
これらのプロンプトを試す
Generate documentation for the Bruno file at api-tests/auth/login.bru
Analyze api-tests/users/create-user.bru with --dry-run to show me the documentation plan
Scan all Bruno files in api-tests/v2/ and write documentation to docs/api-reference.md
Use --scan api-tests/pulse/ --output docs/pulse-api/ to document all Pulse API endpoints with separate files per endpoint
ベストプラクティス
- قم بالتشغيل مع --dry-run أولاً للتحقق من أن الأداة تحدد تنفيذ نقاط النهاية بشكل صحيح قبل إنشاء الوثائق الكاملة
- استخدم وضع ---scan للمعالجة الدفعية لنقاط نهاية متعددة والحفاظ على اتساق الوثائق عبر API الخاص بك
- راجع الوثائق المُنشأة للتحقق من دقتها حيث تعتمد الأداة على مطابقة نمط URL لتحديد موقع الكود الخلفي
回避
- لا تستخدم هذه الأداة بدون ملفات اختبار Bruno كمدخلات، فهي لا يمكنها إنشاء وثائق من تنسيقات مواصفات API الأخرى
- لا تتوقع أن تتحقق الأداة أو تنفذ نقاط نهاية API، بل تقوم فقط بتحليل الكود الثابت لإنتاج الوثائق
- لا تستخدم للمشاريع غير Django بدون تخصيص، حيث تفترض الأداة أنماط Django REST Framework أو Django Ninja