المهارات api-documenter
📦

api-documenter

مراجعة المحتوى r2 آمن

إنشاء توثيق API دقيق

تفقد فرق API الوقت عندما تنحرف المواصفات والأمثلة والبوابات عن السلوك الفعلي. توجّه هذه المهارة Claude وCodex وClaude Code خلال إنشاء توثيق API دقيق وقابل للصيانة.

يدعم: Claude Codex Code(CC)
🥉 78 برونزي

التثبيت باستخدام Agent لدي

انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.

طلب الوكيل
Review the Skillstore skill "api-documenter" from https://skillstore.io/skills/sickn33-api-documenter.md and its manifest at https://skillstore.io/api/skills/sickn33-api-documenter/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.

موارد مهيّأة لـ Agents

استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.

تفاصيل Markdown GET /skills/sickn33-api-documenter.md manifest موقَّع GET /api/skills/sickn33-api-documenter/manifest lockfile موقَّع GET /api/skills/sickn33-api-documenter/lockfile

اختبرها

جارٍ استخدام "api-documenter". تملك REST API توثيق مصادقة غير مكتمل وملاحظات نقاط نهاية متفرقة.

النتيجة المتوقعة:

خطة توثيق تغطي تدفقات OAuth، وإرشادات تحديث الرمز المميز، ومجموعات نقاط النهاية، وأمثلة الاستجابات، ومعالجة الأخطاء، ونقاط التحقق للمراجعة.

جارٍ استخدام "api-documenter". يحتاج فريق إلى دليل ترحيل لتغيير إصدار API يتضمن تغييرات كاسرة.

النتيجة المتوقعة:

مخطط ترحيل يتضمن شرائح الجمهور، وملخصات التغييرات الكاسرة، وخطوات الترقية، وملاحظات التوافق، وإرشادات الاختبار، ورسائل الطرح.

جارٍ استخدام "api-documenter". تفتقر بوابة مطورين إلى بنية إعداد أولي وبحث.

النتيجة المتوقعة:

خريطة بوابة تتضمن تدفق البدء السريع، ومسار المصادقة، وأقسام SDK، وصفحات استكشاف الأخطاء وإصلاحها، وحلقات الملاحظات، واحتياجات التحليلات، وملكية الصيانة.

التدقيق الأمني

آمن
v5 • ٢٣‏/٧‏/٢٠٢٦ فتح التقرير المرتبط بالإصدار

All three static findings are false positives caused by ordinary documentation language. The skill contains guidance only, with no network reconnaissance instructions, executable code, or prompt injection.

1
الملفات التي تم فحصها
188
الأسطر التي تم تحليلها
0
عناصر المراجعة
0
تم تجاهل الإيجابيات الكاذبة
لم يكتشف أحدث تدقيق ثابت ودلالي مكتمل أي نتائج أمنية مؤكدة. ولا يثبت ذلك أن المهارة خالية من الآثار الجانبية.
دقّقه: codex عرض سجل التدقيق →
شارك واستشهد بهذا التقرير

شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.

فتح التقرير المرتبط بالإصدار
تقييم الأمان

نسخ رابط التقرير

https://skillstore.io/skills/sickn33-api-documenter/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

شارة Markdown

[![Skillstore security assessment](https://skillstore.io/badges/skills/sickn33-api-documenter/security.svg)](https://skillstore.io/skills/sickn33-api-documenter?utm_source=security_passport_badge)

شارة HTML

<a href="https://skillstore.io/skills/sickn33-api-documenter?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/sickn33-api-documenter/security.svg" alt="Skillstore security assessment" loading="lazy"></a>

بطاقة قابلة للتضمين

<iframe src="https://skillstore.io/embed/skills/sickn33-api-documenter.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

sickn33. (2026). api-documenter security audit report (audit version 5) [Author version unspecified]. Skillstore. https://skillstore.io/skills/sickn33-api-documenter/audits/5

اقتباس BibTeX

@techreport{sickn33-sickn33-api-documenter-2026, author = {sickn33}, title = {api-documenter security audit report (audit version 5)}, institution = {Skillstore}, year = {2026}, number = {5}, url = {https://skillstore.io/skills/sickn33-api-documenter/audits/5}, note = {Author version unspecified} }

CITATION.cff

cff-version: 1.2.0 message: "If you use this Skill, cite its author and this versioned security audit report." title: "api-documenter security audit report (audit version 5)" version: "unspecified" type: report authors: - name: "sickn33" date-released: "2026-07-23" url: "https://skillstore.io/skills/sickn33-api-documenter/audits/5" identifiers: - type: other value: "skillstore:sickn33-api-documenter:audit:5" description: "Skillstore immutable audit report identifier"

تقييم Skillstore

سبب هذا التقييم موثوقية الأدلة: مرتفع
55
الهندسة المعمارية
85
قابلية الصيانة
87
المحتوى
69
المجتمع
83
الامتثال للمواصفات

ما الذي يمكنك بناؤه

كتابة توثيق API جاهز للإطلاق

إنشاء أدلة نقاط النهاية، وشروحات المصادقة، والأمثلة، ومراجع الأخطاء قبل إصدار API جديد.

توحيد مواصفات API

تحويل ملاحظات نقاط النهاية غير المتسقة إلى مواصفات OpenAPI أو AsyncAPI مع مخططات وأمثلة.

تحسين إعداد المطورين

تصميم بنية البوابة، ووثائق SDK، ومسارات الترحيل التي تساعد المطورين على التكامل بشكل أسرع.

جرّب هذه الموجّهات

توثيق نقطة نهاية واحدة 
استخدم api-documenter لكتابة توثيق واضح لنقطة النهاية هذه. ضمّن الغرض، والمعلمات، والمصادقة، والاستجابات، والأخطاء، ومثال طلب واحد.
إنشاء خطة OpenAPI 
استخدم api-documenter لمراجعة سطح API هذا واقتراح خطة توثيق OpenAPI 3.1. حدّد المخططات والأمثلة وتدفقات المصادقة المفقودة.
بناء مخطط بوابة مطورين 
استخدم api-documenter لتصميم بوابة مطورين لهذه APIs. ضمّن التنقل، ومسار الإعداد الأولي، واحتياجات البحث، ووثائق SDK، وتدفق عمل الصيانة.
تدقيق وتحديث توثيق API 
استخدم api-documenter لتدقيق مجموعة التوثيق هذه من حيث تجربة المطور، والدقة، وإدارة الإصدارات، والاختبار، واحتياجات الترحيل. رتّب الإصلاحات حسب الأولوية مع توضيح الأسباب.

أفضل الممارسات

  • قدّم سلوك API الفعلي، وقواعد المصادقة، وحمولات أمثلة قبل طلب التوثيق النهائي.
  • اطلب خطوات تحقق كي تبقى المواصفات والمقتطفات والأدلة متوافقة مع التنفيذ.
  • راجع التوثيق المولّد مع أصحاب المصلحة في المنتج والهندسة والأمن والدعم قبل النشر.

تجنب

  • لا تطلب منه اختراع سلوك نقاط النهاية دون مواد مصدرية أو افتراضات واضحة.
  • لا تنشر إرشادات أمنية مولّدة دون مراجعة من مالكين مؤهلين.
  • لا تعامل توليد التوثيق كبديل لاختبار عقود API.

الأسئلة المتكررة

هل يمكن لهذه المهارة إنشاء مواصفات OpenAPI؟
نعم. يمكنه توجيه تأليف مواصفات OpenAPI 3.1 مع المخططات والأمثلة وتدفقات المصادقة وتخطيط التحقق.
هل تدعم توثيق AsyncAPI وGraphQL؟
نعم. تغطي المهارة AsyncAPI، وتوثيق مخططات GraphQL، وwebhooks، وأنماط توثيق API المدفوعة بالأحداث.
هل يمكنه إنشاء توثيق SDK؟
نعم. يمكنه تخطيط وثائق SDK، وأمثلة الاستخدام، وملاحظات توزيع الحزم، وإرشادات مكتبات العملاء المولّدة.
هل يمكنه التحقق من أن API يعمل؟
فقط عندما يمتلك الوكيل المضيف وصولا إلى الاختبارات أو المواصفات أو بيئات API. بخلاف ذلك يمكنه تحديد خطوات التحقق.
هل هذا مفيد لبوابات المطورين؟
نعم. يمكنه تصميم تنقل البوابة، وتدفقات الإعداد الأولي، ومستكشفات API، وبنية البحث، وتدفقات عمل الصيانة.
أي المساعدين يمكنهم استخدام هذه المهارة؟
يسرد التقرير الدعم لكل من Claude وCodex وClaude Code.

تفاصيل المطور

المؤلف

sickn33

الترخيص

MIT

مراجعة Skillstore

r2

تنبيه الإصدار

لم يعلن المؤلف عن إصدار.

المستودع

https://github.com/sickn33/antigravity-awesome-skills/tree/main/skills/api-documenter

مرجع

ebdfe608f5de2b66ff37ab4af12af8ac4f5e8006

حداثة الصيانة

٢٦‏/٧‏/٢٠٢٦

الاستخدام

6 تنزيلات · 108 مشاهدات

بنية الملفات

📄 SKILL.md

المزيد من sickn33

عرض الكل

مهارات ذات صلة

عرض الكل
📦

doc-coauthoring

79

توثيق المشاركة مع الذكاء الاصطناعي

بواسطة ZhanlinCui

إن إنشاء وثائق عالية الجودة يمثل تحدياً كبيراً. توفر هذه المهارة طريقة عمل منظمة من ثلاث مراحل تساعد المستخدمين على جمع السياق، وصقل المحتوى من خلال التكرار، واختبار الوثائق مع نسخة جديدة من الذكاء الاصطناعي لضمان وضوحها للقارئ.

التوثيق عرض