كاتب مواصفات OpenAPI
SHA-256:
827e205a3c15f280261e0c745978285edcced8c281ca5a0c415039b2d27e52c8
2 كيلوبايت
ثبّت هذه المهارة مباشرة داخل وكيلك
اختر الوكيل، انسخ الأمر، وشغّله من مجلد مشروعك. يتولى CLI تنزيل الحزمة والتحقق من بصمة SHA-256 ووضع الملفات في المسار المناسب.
npx @ai-dalil/skills add openapi-spec-writer --agent codex@ai-dalil/skills على npm - Node.js 18.18 أو أحدث.
الوصف
عربي
يكتب مواصفات OpenAPI كاملة: مسارات، مخططات، أمثلة استجابة، وأكواد أخطاء، صالحة لأدوات التوليد والاختبار.
English
Write complete OpenAPI specs: paths, schemas, response examples, and error codes valid for generation and testing tools.
بيانات المهارة التقنية
- SKILL name
openapi-spec-writer- الوصف الأصلي
- Write complete OpenAPI specs: paths, schemas, response examples, and error codes valid for generation and testing tools.
- إصدار المهارة
2.0.0- التوافق
- اتصال شبكة · مفاتيح API من المستخدم
- الأدوات المسموح بها
Read, Write- الكلمات المفتاحية
- openapi, documentation, api, standards
- لغة المصدر
- multilingual
- الفرع / المرجع
main- دليل الترخيص
- Original editorial content authored for the AiDalil catalog and released under MIT by the catalog owner. (high)
بيانات المصدر الأصلية (YAML)
عرض Frontmatter الأصلي
name: openapi-spec-writer description: Write complete OpenAPI specs: paths, schemas, response examples, and error codes valid for generation and testing tools. version: 2.0.0 metadata: author: AiDalil Editorial category: api-integration compatibility: droid, claude-code, zed, trae, windsurf, api difficulty: intermediate tags: [openapi, documentation, api, standards]
تعليمات SKILL.md
المحتوى الأصلي للمهارة كما ورد من المصدر، مع الحفاظ على تنسيق Markdown.
عرض التعليمات الكاملة
# Openapi Spec Writer **Goal:** Write complete OpenAPI specs: paths, schemas, response examples, and error codes valid for generation and testing tools. > الهدف: يكتب مواصفات OpenAPI كاملة: مسارات، مخططات، أمثلة استجابة، وأكواد أخطاء، صالحة لأدوات التوليد والاختبار. ## When to use - الحالة النموذجية: يكتب مواصفات OpenAPI كاملة: مسارات، مخططات، أمثلة استجابة، وأكواد أخطاء، صالحة لأدوات التوليد والاختبار. - كتابة أو مراجعة مواصفة واجهة برمجية قبل البناء. - دمج مزود خدمة خارجي في المنتج بأمان. - معالجة تضارب مزامنة البيانات بين نظامين. - مراجعة أمان ربط الدفع أو الهوية أو الرسائل. ## Workflow 1. خطط للأخطاء: كل رمز خطأ خارجي له تصرف داخلي محدد. 2. اقرأ المواصفة الرسمية للمزود وسجّل الحدود والقيود والأسعار. 3. اختبر الحالات الحقيقية: بطء، فشل جزئي، تكرار، وترتيب مخالف. 4. صمّم العقد: الحقول، الصيغ، القيم الافتراضية، وحالات الفراغ. 5. حدّد التكامل: كاتب مواصفات OpenAPI. اذكر الأطراف واتجاه البيانات ومتطلبات الاتساق. 6. أضف المهلة وإعادة المحاولة مع تراجع تدريجي وحماية من العواصف. 7. صمّم الطلب كعملية قابلة لإعادة التشغيل بأمان عند التكرار. 8. وثّق سجل التكامل: الإعدادات، الحدود، وسلوك التعافي. ## Rules - كل رسالة خطأ خارجية تُترجم إلى معنى داخلي موحد. - لا تكامل بلا مهلة صريحة لكل نداء خارجي. - لا تفترض ترتيباً أو اكتمالاً لم تضمنه المواصفة. - خطة تعطيل المزود مكتوبة: ماذا يعمل وماذا يتوقف؟ - راقب نسبة نجاح المزود وزمنه كمؤشر مستقل. ## Output contract - إعدادات مهلة وإعادة محاولة مبررة. - سيناريوهات اختبار فشل ونتائجها. - جدول أخطاء خارجية وترجمتها الداخلية. - دليل تشغيل التكامل ومراقبته. ## Quality checks - [ ] هل إعادة المحاولة لا تضاعف الأثر المالي أو الرسائل؟ - [ ] هل كل المسارات تتعامل مع انتهاء المهلة والفشل الجزئي؟ - [ ] هل التوثيق الداخلي يطابق المواصفة الرسمية الحالية؟ - [ ] هل التوقيعات والتحقق من مصدر الطلبات مفعّلة حيث تُعرض؟ - [ ] هل السجلات تتيح تشخيص نداء فاشل دون كشف أسرار؟ ## Skill identity - Skill name: `openapi-spec-writer` - Version: 2.0.0 - Domain: API and Integration Engineering (هندسة API والتكاملات) - Tags: openapi, documentation, api, standards
التثبيت اليدوي
استخدم هذا المسار عند عدم استخدام CLI أو عند إدارة ملفات المهارات يدويًا.
- نزّل ملف ZIP للإصدار المطلوب من أعلى الصفحة، أو افتح المصدر الأصلي إذا لم تتوفر حزمة مستضافة.
- فك الضغط، ثم انقل مجلد المهارة الذي يحتوي مباشرة على SKILL.md إلى مجلد الوكيل.
- أعد تحميل الوكيل أو افتح جلسة جديدة، ثم تأكد من ظهور المهارة ضمن المهارات المتاحة.
.agents/skills/openapi-spec-writer/.claude/skills/openapi-spec-writer/.cursor/skills/openapi-spec-writer/تعليمات خاصة بهذه المهارة
Extract the skill folder into your agent's skills directory (for example the project skills folder) or install the ZIP package from the skill page. No build step is required; everything is Markdown.
حالات الاستخدام
• مراجعة أمان ربط الدفع أو الهوية أو الرسائل. • كتابة أو مراجعة مواصفة واجهة برمجية قبل البناء. • معالجة تضارب مزامنة البيانات بين نظامين.
المتطلبات
• Any Agent Skills compatible assistant (Claude Code, Claude Desktop, or API agents). • Basic file access to read the bundled reference playbook. • No external services required for the standard workflow.
الإصدارات
| الإصدار | الحجم | الملفات | تاريخ النشر | تنزيل |
|---|---|---|---|---|
vsha-827e205a3c15 |
2 كيلوبايت | 2 | 4 نوفمبر، 2026 | تحميل |
الأمان والفحص
فحص أساسي ✓ — 1 نوفمبر، 2026