api-design-framework
تصميم عقود API جاهزة للإنتاج
غالبا ما تصمم الفرق واجهات API بموارد وأخطاء وإصدارات غير متسقة. توفر هذه المهارة أنماطا وقوائم تحقق وقوالب للعمل على REST وGraphQL وgRPC وOpenAPI وAsyncAPI.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "api-design-framework" from https://skillstore.io/skills/ariegoldkin-api-design-framework.md and its manifest at https://skillstore.io/api/skills/ariegoldkin-api-design-framework/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "api-design-framework". الطلب: صمم API للمستخدمين لإدارة الحسابات.
النتيجة المتوقعة:
نموذج موارد يتضمن نقاط نهاية المستخدمين وطرق HTTP ورموز الحالة وقواعد التقسيم إلى صفحات وإرشادات أخطاء تحقق منظمة.
جارٍ استخدام "api-design-framework". الطلب: قرر بين REST وGraphQL للوحة معلومات.
النتيجة المتوقعة:
- مقارنة بين مرونة الاستعلام والتخزين المؤقت وتعقيد العميل والحوكمة.
- توصية تستند إلى احتياجات المستهلكين والقيود التشغيلية.
جارٍ استخدام "api-design-framework". الطلب: حضر توثيق الأحداث لمعالجة الطلبات.
النتيجة المتوقعة:
خريطة أحداث موجهة نحو AsyncAPI تتضمن القنوات وأسماء الرسائل ومفاهيم الحمولة ومخططات الأمان وتوقعات إعادة المحاولة.
التدقيق الأمني
آمنAll 113 static findings are false positives caused by Markdown backticks, API identifiers, and illustrative URLs in documentation and templates. The files contain no executable commands, runtime network requests, system reconnaissance instructions, or prompt injection text. No semantic security issue was found.
عوامل الخطر
⚙️ الأوامر الخارجية (50)
🌐 الوصول إلى الشبكة (14)
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/ariegoldkin-api-design-framework?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/ariegoldkin-api-design-framework?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/ariegoldkin-api-design-framework/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/ariegoldkin-api-design-framework.html" title="Skillstore Security Assessment" sandbox="allow-popups allow-popups-to-escape-sandbox" loading="lazy" referrerpolicy="no-referrer" width="420" height="180"></iframe>الاستشهادات الأكاديمية (APA · BibTeX · CFF)
اقتباس APA
AI Agent Hub. (2026). api-design-framework security audit report (audit version 9) [Author version 1.0.0]. Skillstore. https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9اقتباس BibTeX
@techreport{ai-agent-hub-ariegoldkin-api-design-framework-2026,
author = {AI Agent Hub},
title = {api-design-framework security audit report (audit version 9)},
institution = {Skillstore},
year = {2026},
number = {9},
url = {https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9},
note = {Author version 1.0.0}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-design-framework security audit report (audit version 9)"
version: "1.0.0"
type: report
authors:
- name: "AI Agent Hub"
date-released: "2026-07-23"
url: "https://skillstore.io/skills/ariegoldkin-api-design-framework/audits/9"
identifiers:
- type: other
value: "skillstore:ariegoldkin-api-design-framework:audit:9"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: مرتفعما الذي يمكنك بناؤه
تصميم عقد خدمة جديد
حدد الموارد والطرق والأخطاء والتقسيم إلى صفحات والمصادقة قبل بدء التنفيذ.
توحيد حوكمة API
أنشئ اصطلاحات مشتركة لواجهات REST وGraphQL وgRPC وOpenAPI وAsyncAPI عبر الفرق.
مراجعة جاهزية إطلاق API
تحقق من إدارة الإصدارات والتوثيق ومعالجة الأخطاء وحدود معدل الطلبات وخطط الإيقاف التدريجي قبل الإصدار.
جرّب هذه الموجّهات
استخدم API Design Framework لاقتراح أسماء الموارد والطرق ورموز الحالة وتنسيقات الأخطاء لواجهة API بسيطة لملف تعريف العميل.
استخدم API Design Framework لوضع مخطط لعقد OpenAPI 3.1 لواجهة API للفوترة تتضمن المصادقة والتقسيم إلى صفحات وأخطاء التحقق.
استخدم API Design Framework لمقارنة REST وGraphQL وgRPC لخدمة بحث داخلية. أوص بنهج واحد مع توضيح المفاضلات.
استخدم API Design Framework لمراجعة اقتراح API هذا من حيث إدارة الإصدارات والتفويض والتكرارية الآمنة والقابلية للمراقبة ومخاطر التغييرات الكاسرة: [paste proposal].
أفضل الممارسات
- ابدأ بحدود الموارد وسير عمل المستهلكين ودلالات الأخطاء قبل اختيار الصياغة.
- استخدم إدارة الإصدارات وفترات الإيقاف التدريجي والتغييرات الإضافية لحماية العملاء الحاليين.
- راجع القوالب مع مالكي الواجهة الخلفية والواجهة الأمامية والأمان والمنصة قبل الإطلاق.
تجنب
- لا تنسخ مجالات الأمثلة أو المعرفات أو الحمولات إلى الإنتاج دون تكييفها.
- لا تكشف جداول قاعدة البيانات أو أسماء الطرق الداخلية أو تفاصيل التنفيذ في عناوين URL.
- لا تعامل مخططات أمان القوالب كضوابط إنتاج نهائية.
الأسئلة المتكررة
هل تولد هذه المهارة كود واجهة خلفية يعمل؟
هل يمكنها المساعدة في OpenAPI وAsyncAPI؟
هل تدعم GraphQL وgRPC؟
هل هي مناسبة لمراجعة API للإنتاج؟
هل يمكن لـ Claude أو Codex أو Claude Code استخدامها؟
هل تستدعي خدمات خارجية؟
تفاصيل المطور
المؤلف
AI Agent Hubالترخيص
MIT
إصدار المؤلف
v1.0.0
مراجعة Skillstore
r2
مرجع
89edfdc710d0846129dcee6a929477b04f08052c
حداثة الصيانة
٢٦/٧/٢٠٢٦
الاستخدام
7 تنزيلات · 295 مشاهدات
بنية الملفات