المهارات api-documentation
📝

api-documentation

آمن

إنشاء توثيق API

متاح أيضًا من: CuriousLearner

يساعد هذا سير العمل المطورين على إنشاء توثيق شامل لـ API من خلال توجيههم عبر إنشاء مواصفات OpenAPI، وكتابة أدلة المطورين، وتوليد أمثلة التعليمات البرمجية، وإعداد التوثيق التفاعلي.

يدعم: Claude Codex Code(CC)
🥉 72 برونزي
1

تنزيل ZIP المهارة

2

رفع في Claude

اذهب إلى Settings → Capabilities → Skills → Upload skill

3

فعّل وابدأ الاستخدام

اختبرها

استخدام "api-documentation". استخدم سير عمل @api-documentation لتوثيق API لإدارة المستخدمين الخاص بي

النتيجة المتوقعة:

سأوجهك عبر إنشاء توثيق شامل لـ API في 7 مراحل:

**المرحلة 1: اكتشاف API**
- جرد نقاط النهاية الخاصة بك
- توثيق تنسيقات الطلب/الاستجابة
- تحديد متطلبات المصادقة

[يوجه عبر كل مرحلة بإجراءات محددة]

استخدام "api-documentation". إنشاء مواصفات OpenAPI لـ API للتجارة الإلكترونية الخاص بي

النتيجة المتوقعة:

إليك بنية مواصفات OpenAPI الخاصة بك:

```yaml
openapi: 3.0.0
info:
title: E-Commerce API
version: 1.0.0
paths:
/products:
get:
summary: List products
responses:
200:
description: Successful response
```

التدقيق الأمني

آمن
v1 • 2/24/2026

Security analysis confirms this is a safe documentation workflow skill. The static analyzer flagged 28 instances of 'external_commands' (Ruby/shell backtick execution) and 9 instances of 'weak cryptographic algorithms', but both are false positives. The backticks in the file are Markdown code spans (e.g., `api-documenter`) used for skill name references, not shell command execution. No actual security risks were identified.

1
الملفات التي تم فحصها
165
الأسطر التي تم تحليلها
2
النتائج
1
إجمالي عمليات التدقيق
مشكلات متوسطة المخاطر (2)
SKILL.md:31SKILL.md:32SKILL.md:42-44SKILL.md:44-49SKILL.md:49-50SKILL.md:50-60SKILL.md:60-62SKILL.md:62-67SKILL.md:67-68SKILL.md:68-78SKILL.md:78-80SKILL.md:80-85SKILL.md:85-86SKILL.md:86-96SKILL.md:96-98SKILL.md:98-103SKILL.md:103-113SKILL.md:113-115SKILL.md:115-120SKILL.md:120-121SKILL.md:121-131SKILL.md:131-133SKILL.md:133-138SKILL.md:138-148SKILL.md:148-150SKILL.md:150-162SKILL.md:162-163SKILL.md:163-164
False Positive: Markdown Code Spans Flagged as Shell Commands
Static analyzer detected 'Ruby/shell backtick execution' at 28 locations, but these are Markdown inline code formatting (backticks around skill names like `api-documenter`), not shell command substitution. This is a false positive.
SKILL.md:3SKILL.md:15SKILL.md:22SKILL.md:32SKILL.md:38SKILL.md:125SKILL.md:132
False Positive: Cryptographic Algorithm Detection
Static analyzer flagged 9 instances of 'weak cryptographic algorithm', but this skill is a documentation workflow with no cryptographic operations. Likely triggered by pattern matching on the word 'api' or YAML content.
تم تدقيقه بواسطة: claude

درجة الجودة

38
الهندسة المعمارية
100
قابلية الصيانة
87
المحتوى
50
المجتمع
95
الأمان
83
الامتثال للمواصفات

ماذا يمكنك بناءه

توثيق مشروع API جديد

إنشاء توثيق كامل لـ REST API جديد من الصفر، بما في ذلك مواصفات OpenAPI، ودليل المطور، والتوثيق التفاعلي.

تحديث توثيق API قديم

تحديث وتحديث توثيق API الموجود لتضمين مواصفات OpenAPI وأمثلة الكود وميزات التجربة التفاعلية.

إنشاء بوابة API داخلية

بناء بوابة API داخلية مع توثيق شامل وعينات من الكود وأدلة التكامل للفرق الداخلية.

جرّب هذه الموجهات

بدء توثيق API 
استخدم سير عمل @api-documentation لإنشاء توثيق لـ REST API الخاص بي. لدي قائمة نقاط نهاية وأحتاج مساعدة في توليد مواصفات OpenAPI ودليل المطور.
توليد مواصفات OpenAPI 
استخدم @api-documentation لإنشاء مواصفات OpenAPI لـ API الخاص بي. يحتوي API على مصادقة عبر JWT ويشمل نقاط نهاية للمستخدمين والمنتجات والطلبات.
إضافة أمثلة كود 
استخدم سير عمل @api-documentation لإضافة أمثلة كود إلى توثيق API الموجود لدي. أحتاج أمثلة في Python و JavaScript و cURL.
إعداد التوثيق التفاعلي 
استخدم @api-documentation لإعداد توثيق تفاعلي مع Swagger UI و Redoc لمواصفات OpenAPI الموجودة لدي. قم بتكوين وظيفة التجربة.

أفضل الممارسات

  • ابدأ باكتشاف API لفهم جميع نقاط النهاية قبل توليد التوثيق
  • احتفظ بمواصفات OpenAPI متزامنة مع تغييرات API الفعلية باستخدام الأتمتة
  • اختبر جميع أمثلة الكود للتأكد من عملها في بيئات الإنتاج

تجنب

  • تخطي مرحلة الاكتشاف والقفز مباشرة إلى توليد التوثيق
  • توليد التوثيق دون التحقق من دقة مواصفات API
  • إنشاء مستندات ثابتة لا يتم تحديثها أبدًا عند تغير APIs

الأسئلة المتكررة

ما المهام التي يستدعيها سير العمل هذا؟
يستدعي هذا سير العمل مهام مثل api-documenter و openapi-spec-generation و api-documentation-generator و docs-architect وغيرها لأداء مهام توثيق محددة.
هل أحتاج إلى تثبيت مهام أخرى؟
نعم، تتطلب بعض المراحل مهام أخرى مثل api-documenter و openapi-spec-generation و documentation-templates لتكون متاحة في مكتبة المهام الخاصة بك.
هل يمكن لهذا سير العمل توليد توثيق لـ GraphQL APIs؟
سير العمل هذا محسّن لـ REST APIs مع مواصفات OpenAPI. دعم GraphQL يتطلب تكييفًا أو مهام إضافية.
كيف أحافظ على تحديث توثيق API الخاص بي؟
تغطي المرحلة 7 إعد��د الأتمتة مع التحقق والمراقبة. يمكنك تكوين webhooks لتشغيل إعادة بناء التوثيق عند تغير APIs.
ما تنسيقات الإخراج التي يدعمها سير العمل هذا؟
ينتج سير العمل OpenAPI (YAML/JSON) وأدلة المطورين بتنسيق Markdown وأمثلة كود بلغات متعددة ويقوم بتكوين Swagger UI أو Redoc للتثيق التفاعلي.
هل يمكنني تخصيص قالب التوثيق؟
نعم، يمكنك تعديل مراحل سير العمل والمطالبات لمطابقة معايير التوثيق ومتطلبات العلامة التجارية لمؤسستك.

تفاصيل المطور

المؤلف

sickn33

الترخيص

MIT

المستودع

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documentation

مرجع

main

بنية الملفات

📄 SKILL.md