تخطَّ إلى المحتوى
+ أضف منتج إنشاء حساب تسجيل الدخول

مصمم واجهات REST

تطوير الخلفية agent-skills cli rest MIT
⬇ تنزيل vsha-d47799a1c01d

SHA-256: d47799a1c01deb490d56abf02c853893e7b0804b1394ff90ae1dd4de1c127890 3 كيلوبايت

✦ جاهزة لبيئة عملك

ثبّت هذه المهارة مباشرة داخل وكيلك

اختر الوكيل، انسخ الأمر، وشغّله من مجلد مشروعك. يتولى CLI تنزيل الحزمة والتحقق من بصمة SHA-256 ووضع الملفات في المسار المناسب.

$npx @ai-dalil/skills add rest-api-designer --agent codex

@ai-dalil/skills على npm - Node.js 18.18 أو أحدث.

↓ تنزيل ZIP · الإصدار sha-d47799a1c01d بيانات API ↗ سجل الإصدارات ↗

الوصف

عربي

يصمم واجهات REST متسقة: موارد واضحة، رموز حالة صحيحة، ترقيم موحد، وجسم خطأ واحد قابل للتصرف.

English

Design consistent REST APIs: clear resources, correct status codes, unified pagination, and one actionable error body.

بيانات المهارة التقنية

SKILL name
rest-api-designer
الوصف الأصلي
Design consistent REST APIs: clear resources, correct status codes, unified pagination, and one actionable error body.
إصدار المهارة
1.0.0
التوافق
بيئة خادم بـPHP 8+ أو Node.js 18+ حسب المشروع
الأدوات المسموح بها
Read, Write, Bash
الكلمات المفتاحية
rest, api-design, backend, architecture
لغة المصدر
multilingual
الفرع / المرجع
main
دليل الترخيص
Original editorial content authored for the AiDalil catalog and released under MIT by the catalog owner. (high)

بيانات المصدر الأصلية (YAML)

عرض Frontmatter الأصلي
name: rest-api-designer
description: Design consistent REST APIs: clear resources, correct status codes, unified pagination, and one actionable error body.
version: 1.0.0
metadata:
  author: AiDalil Editorial
  category: backend
  compatibility: crush, opencode, roo-code, cursor, cline, api
  difficulty: intermediate
  tags: [rest, api-design, backend, architecture]

تعليمات SKILL.md

المحتوى الأصلي للمهارة كما ورد من المصدر، مع الحفاظ على تنسيق Markdown.

عرض التعليمات الكاملة
# Rest Api Designer

**Goal:** Design consistent REST APIs: clear resources, correct status codes, unified pagination, and one actionable error body.

> الهدف: يصمم واجهات REST متسقة: موارد واضحة، رموز حالة صحيحة، ترقيم موحد، وجسم خطأ واحد قابل للتصرف.

## When to use
- الحالة النموذجية: يصمم واجهات REST متسقة: موارد واضحة، رموز حالة صحيحة، ترقيم موحد، وجسم خطأ واحد قابل للتصرف.
- إضافة ميزة جديدة تتطلب نقاط نهاية أو مهام خلفية.
- تحسين أداء الاستعلامات وزمن الاستجابة.
- توثيق عقود الواجهات بين الخدمات.
- إصلاح أخطاء منطق الأعمال أو تدفقات البيانات الخلفية.

## Workflow
1. راجع الأثر على الأداء: عدد الاستعلامات، الأقفال، والذاكرة.
2. صمّم الحل على الورق: نقاط النهاية، الجداول، وقوائم الانتظار إن وُجدت.
3. أضف التحقق من المدخلات ومعالجة أخطاء صريحة برسائل قابلة للتنفيذ.
4. صِغ الهدف: مصمم واجهات REST. اذكر العقد المتوقع: المدخلات، المخرجات، ورسائل الخطأ.
5. جهّز خطة تراجع وحدّد نقطة تحقق قبل النشر.
6. وثّق التغيير في سجل الواجهات وحدّث أمثلة الطلبات والاستجابات.
7. اقرأ الكود المحيط وارسم التدفق الحالي للبيانات قبل أي تعديل.
8. اكتب اختبارات فاشلة أولاً تغطي الحالة الرئيسية وحالات الحدود.

## Rules
- لا تُغيّر عقداً عاماً دون إصدار جديد أو توافق صريح مع المستهلكين.
- الأسرار تُقرأ من الإعدادات الآمنة فقط ولا تُكتب في الكود.
- كل نقطة نهاية تتحقق من الصلاحيات قبل أي قراءة أو كتابة.
- العمليات المالية والحساسة تُنفَّذ بطريقة قابلة لإعادة المحاولة الآمنة.
- لا استعلامات داخل حلقات؛ اجمع ثم استعلم دفعة واحدة.

## Output contract
- ملخص اختبارات مع أعداد الحالات الناجحة.
- وصف تغيير بصيغة: السبب، الحل، الأثر، وطريقة الاختبار.
- قائمة نقاط النهاية أو الجداول المتأثرة.
- أمثلة طلبات واستجابات جاهزة للنسخ.

## Quality checks
- [ ] هل تغطي الاختبارات الحالات الحدودية والمدخلات غير الصالحة؟
- [ ] هل خطة التراجع مكتوبة ومجرَّبة على بيئة شبيهة بالإنتاج؟
- [ ] هل عادت جميع الاختبارات الموجودة إلى الاخضرار بعد التغيير؟
- [ ] هل التوثيق محدث ويطابق السلوك الفعلي؟
- [ ] هل السجلات تسمح بتتبع طلب واحد من بدايته لنهايته؟

## Skill identity
- Skill name: `rest-api-designer`
- Version: 1.0.0
- Domain: Backend Development (تطوير الخلفية)
- Tags: rest, api-design, backend, architecture

التثبيت اليدوي

استخدم هذا المسار عند عدم استخدام CLI أو عند إدارة ملفات المهارات يدويًا.

  1. نزّل ملف ZIP للإصدار المطلوب من أعلى الصفحة، أو افتح المصدر الأصلي إذا لم تتوفر حزمة مستضافة.
  2. فك الضغط، ثم انقل مجلد المهارة الذي يحتوي مباشرة على SKILL.md إلى مجلد الوكيل.
  3. أعد تحميل الوكيل أو افتح جلسة جديدة، ثم تأكد من ظهور المهارة ضمن المهارات المتاحة.
Codex.agents/skills/rest-api-designer/
Claude Code.claude/skills/rest-api-designer/
Cursor.cursor/skills/rest-api-designer/

تعليمات خاصة بهذه المهارة

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-d47799a1c01d 3 كيلوبايت 2 4 نوفمبر، 2026 تحميل

الأمان والفحص

فحص أساسي ✓ — 1 نوفمبر، 2026

مجتمع يبني قدرات أفضل

هل طوّرت مهارة تستحق أن يكتشفها الآخرون؟

ساهم في إثراء مكتبة المهارات، وعرّف المجتمع على عملك مع حفظ نسبه إلى مصدره الأصلي.

أرسل مهارة كيف تعمل المهارات؟
قسم المهارات — دليل AIالعودة إلى دليل AI ↗