المهارات api-design-principles
🧭
api-design-principles
آمن 🌐
الوصول إلى الشبكة⚙️
الأوامر الخارجية
تصميم REST و GraphQL APIs بثقة
قرارات تصميم API غالباً ما تصبح غير متسقة وصعبة الصيانة. توفر هذه المهارة أنماطاً وقوالب ونقاط تحقق واضحة لتوجيه اختياراتك.
يدعم: Claude Codex Code(CC)
1
تنزيل ZIP المهارة
2
رفع في Claude
اذهب إلى Settings → Capabilities → Skills → Upload skill
3
فعّل وابدأ الاستخدام
اختبرها
استخدام "api-design-principles". راجع نقاط النهاية الخاصة بالمستخدمين والطلبات لأفضل ممارسات REST.
النتيجة المتوقعة:
- استخدم الأسماء الجمع: /api/users و /api/orders
- استبدل مسارات الإجراءات مثل /api/createUser بـ POST /api/users
- أضف التصفح إلى نقاط النهاية للقوائم باستخدام page و page_size
- أعد 201 Created عند نجاح POST و 204 عند DELETE
استخدام "api-design-principles". كيف يجب أن أبني مخطط GraphQL لمدونة مع المستخدمين والمقالات والتعليقات؟
النتيجة المتوقعة:
- حدد أنواع User و Post و Comment مع العلاقات المناسبة
- استخدم ترقيم المؤشر بنمط Relay للمجموعات
- أنشئ أنواع إدخال للطفرات مع حمولات الأخطاء
- أضف DataLoaders لمنع استعلامات N+1 على العلاقات
استخدام "api-design-principles". ما رموز الحالة التي يجب أن يعيدها API لأخطاء التحقق من الصحة؟
النتيجة المتوقعة:
- أعد 400 Bad Request لصيغة الطلب المشوهة
- أعد 422 Unprocessable Entity لفشل التحقق من الصحة
- تضمن تفاصيل خطأ على مستوى الحقل في جسم الاستجابة
- استخدم تنسيق خطأ متسق عبر جميع نقاط النهاية
التدقيق الأمني
آمنv4 • 1/17/2026
This skill contains only educational documentation, code templates, and best practices for API design. All 233 static findings are false positives: 'weak cryptographic algorithm' flags educational password hashing examples; 'backtick execution' misinterprets markdown code formatting; 'system reconnaissance' triggers on legitimate programming terms like fetch/decode; hardcoded URLs/IPs are documentation examples, not actual network calls. No executable code, network calls, or data access patterns pose security risks.
6
الملفات التي تم فحصها
2,011
الأسطر التي تم تحليلها
2
النتائج
4
إجمالي عمليات التدقيق
عوامل الخطر
🌐 الوصول إلى الشبكة (7)
⚙️ الأوامر الخارجية (134)
references/graphql-schema-design.md:6-35 references/graphql-schema-design.md:35-40 references/graphql-schema-design.md:40-48 references/graphql-schema-design.md:48-51 references/graphql-schema-design.md:51-72 references/graphql-schema-design.md:72-75 references/graphql-schema-design.md:75-99 references/graphql-schema-design.md:99-102 references/graphql-schema-design.md:102-122 references/graphql-schema-design.md:122-127 references/graphql-schema-design.md:127-171 references/graphql-schema-design.md:171-174 references/graphql-schema-design.md:174-185 references/graphql-schema-design.md:185-190 references/graphql-schema-design.md:190-212 references/graphql-schema-design.md:212-215 references/graphql-schema-design.md:215-231 references/graphql-schema-design.md:231-234 references/graphql-schema-design.md:234-254 references/graphql-schema-design.md:254-259 references/graphql-schema-design.md:259-296 references/graphql-schema-design.md:296-299 references/graphql-schema-design.md:299-314 references/graphql-schema-design.md:314-318 references/graphql-schema-design.md:318-343 references/graphql-schema-design.md:343-347 references/graphql-schema-design.md:347-364 references/graphql-schema-design.md:364-369 references/graphql-schema-design.md:369-388 references/graphql-schema-design.md:388-391 references/graphql-schema-design.md:391-404 references/graphql-schema-design.md:404-409 references/graphql-schema-design.md:409-452 references/graphql-schema-design.md:452-455 references/graphql-schema-design.md:455-474 references/graphql-schema-design.md:474-479 references/graphql-schema-design.md:479-493 references/graphql-schema-design.md:493-496 references/graphql-schema-design.md:496-507 references/graphql-schema-design.md:507-510 references/graphql-schema-design.md:510-520 references/graphql-schema-design.md:520-525 references/graphql-schema-design.md:525-531 references/graphql-schema-design.md:531-534 references/graphql-schema-design.md:534-553 references/graphql-schema-design.md:553-562 references/rest-best-practices.md:6-16 references/rest-best-practices.md:16-19 references/rest-best-practices.md:19-28 references/rest-best-practices.md:28-33 references/rest-best-practices.md:33-37 references/rest-best-practices.md:37-40 references/rest-best-practices.md:40-50 references/rest-best-practices.md:50-53 references/rest-best-practices.md:53-60 references/rest-best-practices.md:60-63 references/rest-best-practices.md:63-68 references/rest-best-practices.md:68-71 references/rest-best-practices.md:71-76 references/rest-best-practices.md:76-81 references/rest-best-practices.md:81-97 references/rest-best-practices.md:97-102 references/rest-best-practices.md:102-113 references/rest-best-practices.md:113-116 references/rest-best-practices.md:116-125 references/rest-best-practices.md:125-128 references/rest-best-practices.md:128-136 references/rest-best-practices.md:136-141 references/rest-best-practices.md:141-147 references/rest-best-practices.md:147-150 references/rest-best-practices.md:150-156 references/rest-best-practices.md:156-159 references/rest-best-practices.md:159-164 references/rest-best-practices.md:164-169 references/rest-best-practices.md:169-177 references/rest-best-practices.md:177-180 references/rest-best-practices.md:180-217 references/rest-best-practices.md:217-222 references/rest-best-practices.md:222-227 references/rest-best-practices.md:227-230 references/rest-best-practices.md:230-232 references/rest-best-practices.md:232-237 references/rest-best-practices.md:237-253 references/rest-best-practices.md:253-256 references/rest-best-practices.md:256-257 references/rest-best-practices.md:257-258 references/rest-best-practices.md:258-259 references/rest-best-practices.md:259-260 references/rest-best-practices.md:260-261 references/rest-best-practices.md:261-262 references/rest-best-practices.md:262-263 references/rest-best-practices.md:263-264 references/rest-best-practices.md:264-265 references/rest-best-practices.md:265-266 references/rest-best-practices.md:266-267 references/rest-best-practices.md:267-272 references/rest-best-practices.md:272-283 references/rest-best-practices.md:283-288 references/rest-best-practices.md:288-304 references/rest-best-practices.md:304-309 references/rest-best-practices.md:309-315 references/rest-best-practices.md:315-319 references/rest-best-practices.md:319-329 references/rest-best-practices.md:329-333 references/rest-best-practices.md:333-362 references/rest-best-practices.md:362-366 references/rest-best-practices.md:366-385 SKILL.md:31 SKILL.md:32 SKILL.md:33 SKILL.md:34 SKILL.md:35 SKILL.md:54-57 SKILL.md:57-60 SKILL.md:60-62 SKILL.md:62-65 SKILL.md:65-67 SKILL.md:67-73 SKILL.md:73-90 SKILL.md:90-94 SKILL.md:94-151 SKILL.md:151-155 SKILL.md:155-212 SKILL.md:212-216 SKILL.md:216-242 SKILL.md:242-248 SKILL.md:248-349 SKILL.md:349-353 SKILL.md:353-442 SKILL.md:442-446 SKILL.md:446-487 SKILL.md:487-492 SKILL.md:492 SKILL.md:492-506
تم تدقيقه بواسطة: claude عرض سجل التدقيق →
درجة الجودة
55
الهندسة المعمارية
90
قابلية الصيانة
85
المحتوى
21
المجتمع
100
الأمان
87
الامتثال للمواصفات
ماذا يمكنك بناءه
تعريف معايير API جديدة
إنشاء قواعد متسقة لـ REST و GraphQL للفريق قبل التنفيذ.
مراجعة مواصفات API
تدقيق المواصفات لمشاكل التسمية والإصدار ومعالجة الأخطاء.
تحسين قابلية استخدام API
تحسين نقاط النهاية والمخطط لتقليل الارتباك وإعادة العمل.
جرّب هذه الموجهات
مراجعة أساسيات REST
راجع هذا المخطط لـ REST API وسرد إصلاحات التسمية والأساليب ورموز الحالة. قدم مثالاً صحيحاً موجزاً.
فحص مخطط GraphQL
قيّم هذا المخطط لـ GraphQL للتصفح وأنواع الإدخال وأنماط الأخطاء. اقترح تحسينات مع أمثلة موجزة.
استراتيجية الترقيم
اقترح نهج ترقيم لهذا API واشرح المفاضلات. قدم قائمة تحقق للترحيل.
تشغيل قائمة التحقق من التصميم
طبّق قائمة تحقق تصميم API على هذا المخطط وأعد نجاح أو فشل مع إصلاحات لكل عنصر فاشل.
أفضل الممارسات
- وثّق قواعد الإيقاف والإهمال قبل الإطلاق
- استخدم تنسيقات أخطاء متسقة مع رموز أخطاء مستقرة
- صفّح جميع نقاط النهاية للمجموعات مع حدود واضحة
تجنب
- استخدام POST للعمليات للقراءة فقط
- مسارات الموارد المتداخلة بعمق أكثر من مستويين
- إعادة أشكال أخطاء غير متسقة عبر نقاط النهاية
الأسئلة المتكررة
هل هذا متوافق مع Claude و Codex و Claude Code؟
نعم. التوجيه محايد من حيث المنصة ويعمل في Claude و Codex و Claude Code.
ما حدود هذه المهارة؟
يوفر الأنماط والقوالب لكنه لا يُنشئ خدمة API كاملة عاملة.
هل يمكنني دمج هذا مع قاعدة الكود الموجودة؟
نعم. استخدم القائمة تحقق والقوالب لمواءمة نقاط النهاية والمخطط الموجودة لديك.
هل يصل إلى البيانات الحساسة أو يخزنها؟
لا. يوفر فقط إرشادات وأمثلة ثابتة.
ماذا لو لم يكن تصميم API الخاص بي مشمولاً؟
وفر مواصفاتك وأهدافك، ثم اطلب توصيات مستهدفة.
كيف يقارن بنصائح API العامة؟
يتضمن أنماطاً ملموسة لـ REST و GraphQL مع قوائم تحقق وقوالب.