المهارات API Documenter
📝
API Documenter
آمن
產生 API 文件
開發人員需要花費數小時手動編寫 API 文件。此技能可自動從程式碼或 OpenAPI 規格產生全面的 API 文件，節省時間並確保一致性。
يدعم: Claude Codex Code(CC)
1
تنزيل ZIP المهارة
2
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
3
فعّل وابدأ الاستخدام
اختبرها
استخدام "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
التدقيق الأمني
آمن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
المحتوى
50
المجتمع
100
الأمان
74
الامتثال للمواصفات
ماذا يمكنك بناءه
內部服務的快速 API 文件
在開發迭代期間快速為內部微服務產生文件
公開 API 文件
為公開 API 產品建立精緻的使用者面向文件
舊版 API 文件復原
透過分析程式碼為未文件化的舊版 API 產生文件
جرّب هذه الموجهات
基本文件請求
為以下端點產生 API 文件：[貼上端點程式碼或描述]
完整 API 文件
為此 OpenAPI 規格建立全面的 API 文件：[貼上 OpenAPI JSON/YAML]
多語言範例
為以下項目產生包含 Python、JavaScript 和 curl 程式碼範例的 API 文件：[貼上端點詳細資訊]
Markdown 文件
建立精緻的 markdown API 文件，包含概述、端點、驗證、錯誤碼和範例等區段：[貼上 API 規格]
أفضل الممارسات
- 提供完整的 OpenAPI 規格以獲得最佳結果
- 在輸入中包含驗證詳細資訊
- 在發布前檢查產生的範例是否準確
تجنب
- 期望對 API 端點進行即時測試
- 提供不完整或模糊的端點描述
- 假設此技能了解您特定的內部慣例
الأسئلة المتكررة
此技能接受哪些輸入格式？
此技能接受 JSON 或 YAML 格式的 OpenAPI 規格，以及 API 端點的自然語言描述。
此技能可以測試我的 API 端點嗎？
不行，此技能僅產生文件。它無法發出實際的 HTTP 請求來測試端點。
程式碼範例支援哪些程式語言？
此技能可以產生 JavaScript、Python、curl、Ruby、Go 和其他常用語言的範例。
這是否適用於 GraphQL API？
目前此技能專注於 REST API。未來版本可能會加入 GraphQL 支援。
產生的文件有多準確？
準確度取決於輸入規格的完整性。完整的 OpenAPI 規格會產生最準確的文件。
我可以自訂輸出格式嗎？
是的，您可以在提示中指定 markdown、HTML 或其他格式。預設輸出為 markdown。