API Documenter
إنش��ء توثيق API
يقضي المطورون ساعات في كتابة توثيق API يدويًا. تقوم هذه المهام بإنشاء توثيق شامل لـ API تلقائيًا من الكود أو مواصفات OpenAPI، مما يوفر الوقت ويضمن الاتساق.
تنزيل ZIP المهارة
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
فعّل وابدأ الاستخدام
اختبرها
استخدام "API Documenter". Generate API docs for a GET /users/{id} endpoint that returns user profile data
النتيجة المتوقعة:
- # GET /users/{id}
- Retrieves a user profile by unique identifier.
- ## Request
- - Method: GET
- - Path: /users/{id}
- - Auth: Bearer token required
- ## Response 200
- ```json
- {"id": "user_123", "name": "John Doe", "email": "john@example.com"}
- ```
استخدام "API Documenter". Document this OpenAPI spec for a pets API
النتيجة المتوقعة:
- # Pet Store API
- ## Overview
- RESTful API for managing pet inventory.
- ## Endpoints
- - GET /pets - List pets
- - POST /pets - Add pet
- - GET /pets/{id} - Get pet
- - DELETE /pets/{id} - Remove pet
التدقيق الأمني
آمن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.
درجة الجودة
ماذا يمكنك بناءه
توثيق API سريع للخدمات الداخلية
إنشاء توثيق سريع للخدمات المصغرة الداخلية أثناء دورات التطوير
توثيق API العام
إنشاء توثيق مصقول للمستخدمين لمنتجات API العامة
استعادة توثيق API القديم
إنشاء توثيق لواجهات API القديمة غير الموثقة من خلال تحليل الكود
جرّب هذه الموجهات
Generate API documentation for the following endpoint: [paste endpoint code or description]
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]
Create polished markdown API documentation with sections for overview, endpoints, authentication, error codes, and examples: [paste API specification]
أفضل الممارسات
- Provide complete OpenAPI specs for best results
- Include authentication details in the input
- Review generated examples for accuracy before publishing
تجنب
- Expecting live testing of API endpoints
- Providing incomplete or ambiguous endpoint descriptions
- Assuming the skill knows your specific internal conventions