Compétences api-designer
🔌

api-designer

Sûr ⚡ Contient des scripts📁 Accès au système de fichiers

تصميم وتوثيق واجهات برمجة التطبيقات RESTful وGraphQL

توفر هذه المهارة إرشادات شاملة لتصميم وتوثيق وتنفيذ واجهات برمجة التطبيقات الحديثة. تغطي كلاً من نموذجي REST وGraphQL مع أفضل الممارسات في الصناعة وأنماط المصادقة واستراتيجيات الإصدارات لتصميمات API جاهزة للإنتاج.

Prend en charge: Claude Codex Code(CC)
🥈 80 Argent
1

Télécharger le ZIP du skill

2

Importer dans Claude

Allez dans Paramètres → Capacités → Skills → Importer un skill

3

Activez et commencez à utiliser

Tester

Utilisation de "api-designer". تصميم نقاط نهاية المصادقة لـ REST API مع OAuth 2.0

Résultat attendu:

  • POST /auth/register - إنشاء حساب مستخدم جديد بالبريد الإلكتروني وكلمة المرور
  • POST /auth/login - المصادقة واستلام رمز الوصول مع رمز التحديث
  • POST /auth/logout - إبطال رمز التحديث وإنهاء الجلسة
  • POST /auth/refresh - استبدال رمز تحديث صالح برمز وصول جديد
  • GET /auth/me - إرجاع ملف تعريف المستخدم المصادق عليه حالياً
  • استخدام رموز JWT bearer مع خوارزمية توقيع RS256

Utilisation de "api-designer". إنشاء نمط ترقيم الصفحات لمجموعات API الكبيرة

Résultat attendu:

  • يُوصى بترقيم الصفحات المستند إلى المؤشر لمجموعات البيانات الكبيرة
  • تضمين حقول nextCursor وhasMore في الاستجابة
  • ترقيم الصفحات المستند إلى الإزاحة لمجموعات النتائج الأصغر والمتوقعة
  • تضمين العدد الإجمالي دائماً عند الإمكان
  • الحد الافتراضي 20، والحد الأقصى 100 عنصر لكل صفحة

Utilisation de "api-designer". تصميم تنسيق استجابة الأخطاء لـ REST API

Résultat attendu:

  • تضمين رمز الخطأ والرسالة وأخطاء مستوى الحقل المفصلة
  • إضافة معرف الطلب لاستكشاف الأخطاء والارتباط
  • تضمين الطابع الزمني بتنسيق ISO 8601 UTC
  • استخدام رموز حالة HTTP المناسبة: 400، 401، 403، 404، 422، 429، 500
  • عدم كشف البيانات الحساسة أو تتبعات المكدس في استجابات الأخطاء مطلقاً

Audit de sécurité

Sûr
v5 • 1/16/2026

All 661 static findings are FALSE POSITIVES. The skill is a documentation/reference guide for API design containing markdown guides, OpenAPI examples, and a local Python utility. No network operations, no credential access, no command execution. The static analyzer incorrectly flagged cryptographic algorithm names (RS256, HS256) in documentation as 'weak crypto', backticks in markdown as 'shell execution', and REST endpoint paths as 'system reconnaissance'.

10
Fichiers analysés
5,375
Lignes analysées
2
résultats
5
Total des audits

Facteurs de risque

⚡ Contient des scripts (1)
scripts/api_helper.py:1-410
📁 Accès au système de fichiers (2)
scripts/api_helper.py:75 scripts/api_helper.py:288
Audité par: claude Voir l’historique des audits →

Score de qualité

82
Architecture
100
Maintenabilité
87
Contenu
23
Communauté
100
Sécurité
87
Conformité aux spécifications

Ce que vous pouvez construire

إنشاء مواصفات API

تصميم واجهات REST أو GraphQL مع توثيق OpenAPI شامل وأنماط المصادقة.

توثيق واجهات API الموجودة

إنشاء مواصفات OpenAPI من واجهات API الموجودة وإنشاء توثيق تفاعلي.

كتابة توثيق API

تعلم أفضل الممارسات لكتابة توثيق API واضح مع أمثلة الكود وأدلة الأخطاء.

Essayez ces prompts

تصميم REST API 
Design a REST API for user management with endpoints for registration, login, profile management, and password reset. Include proper HTTP methods, status codes, and error response formats.
إنشاء مواصفات OpenAPI 
Create an OpenAPI 3.0 specification for a blog API including posts, comments, and tags. Include authentication with JWT and pagination for collections.
تصميم مخطط GraphQL 
Design a GraphQL schema for an e-commerce application with products, categories, shopping cart, and orders. Include proper input types and pagination.
تخطيط إصدارات API 
Plan an API versioning strategy for introducing breaking changes to an existing v1 API. Should I use URL versioning (e.g., /v2/users) or header versioning (e.g., Accept: application/vnd.api.v2+json)? Include deprecation notices, migration paths, and backward compatibility considerations.

Bonnes pratiques

  • استخدام اصطلاحات تسمية متسقة وهياكل URL وتنسيقات استجابة الأخطاء عبر جميع نقاط النهاية
  • تنفيذ المصادقة الصحيحة وتحديد المعدل لحماية موارد API
  • توثيق جميع نقاط النهاية بمواصفات OpenAPI بما في ذلك الأمثلة ورموز الأخطاء

Éviter

  • تجنب استخدام الأفعال في URLs - يجب أن تستخدم واجهات REST API الأسماء للموارد
  • عدم كشف تفاصيل التنفيذ أو البيانات الحساسة في استجابات الأخطاء
  • تجنب التداخل العميق في URL بما يتجاوز مستويين - استخدم معلمات الاستعلام بدلاً من ذلك

Foire aux questions

ما الفرق بين REST وGraphQL؟
يستخدم REST نقاط نهاية ثابتة مع طرق HTTP محددة بينما يستخدم GraphQL نقطة نهاية واحدة مع استعلامات مرنة. REST أبسط لعمليات CRUD الأساسية، وGraphQL أفضل لمتطلبات البيانات المعقدة.
كيف أقوم بإصدار API دون تعطيل العملاء؟
استخدم إصدارات URL مثل /v1/users أو إصدارات الترويسة. أضف حقولاً جديدة دون إزالة الحقول الموجودة. قدم تحذيرات الإهمال قبل إزالة نقاط النهاية.
ما طريقة المصادقة التي يجب أن أستخدمها؟
OAuth 2.0 للتطبيقات الموجهة للمستخدم، رموز JWT bearer لواجهات API، مفاتيح API للمصادقة البسيطة بين الخدمات. استخدم HTTPS دائماً.
كيف أتعامل مع ترقيم الصفحات في واجهات REST API؟
ترقيم الصفحات المستند إلى المؤشر لمجموعات البيانات الكبيرة في الوقت الفعلي. المستند إلى الإزاحة لمجموعات البيانات الأصغر. تضمين البيانات الوصفية مع العدد الإجمالي والحدود ومؤشرات الترقيم.
ما رموز الحالة التي يجب أن أستخدمها؟
200 للنجاح، 201 للإنشاء، 204 لعدم وجود محتوى، 400 لطلب سيئ، 401 لغير مصرح، 403 لممنوع، 404 لغير موجود، 429 لحدود المعدل، 500 لأخطاء الخادم.
كيف أوثق API الخاص بي؟
استخدم مواصفات OpenAPI 3.0 مع الأوصاف والأمثلة وتفاصيل المعلمات. تضمين متطلبات المصادقة ورموز الأخطاء ومخططات الاستجابة لكل نقطة نهاية.

Détails du développeur

Licence

MIT

Dépôt

https://github.com/AutumnsGrove/ClaudeSkills/tree/master/api-designer

Réf

master

Structure de fichiers

📁 examples/

📄 graphql_schema.graphql

📄 openapi_spec.yaml

📁 references/

📄 authentication.md

📄 common-patterns.md

📄 rest_best_practices.md

📄 versioning-strategies.md

📁 scripts/

📄 api_helper.py

📄 README.md

📄 SKILL.md