api-documenter
إنشاء توثيق API دقيق
تفقد فرق API الوقت عندما تنحرف المواصفات والأمثلة والبوابات عن السلوك الفعلي. توجّه هذه المهارة Claude وCodex وClaude Code خلال إنشاء توثيق API دقيق وقابل للصيانة.
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
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.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「api-documenter」を使用しています。 تملك REST API توثيق مصادقة غير مكتمل وملاحظات نقاط نهاية متفرقة.
期待される結果:
خطة توثيق تغطي تدفقات OAuth، وإرشادات تحديث الرمز المميز، ومجموعات نقاط النهاية، وأمثلة الاستجابات، ومعالجة الأخطاء، ونقاط التحقق للمراجعة.
「api-documenter」を使用しています。 يحتاج فريق إلى دليل ترحيل لتغيير إصدار API يتضمن تغييرات كاسرة.
期待される結果:
مخطط ترحيل يتضمن شرائح الجمهور، وملخصات التغييرات الكاسرة، وخطوات الترقية، وملاحظات التوافق، وإرشادات الاختبار، ورسائل الطرح.
「api-documenter」を使用しています。 تفتقر بوابة مطورين إلى بنية إعداد أولي وبحث.
期待される結果:
خريطة بوابة تتضمن تدفق البدء السريع، ومسار المصادقة، وأقسام SDK، وصفحات استكشاف الأخطاء وإصلاحها، وحلقات الملاحظات، واحتياجات التحليلات، وملكية الصيانة.
セキュリティ監査
安全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.
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/sickn33-api-documenter/audits/5?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](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/5BibTeX形式の引用
@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 スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
كتابة توثيق API جاهز للإطلاق
إنشاء أدلة نقاط النهاية، وشروحات المصادقة، والأمثلة، ومراجع الأخطاء قبل إصدار API جديد.
توحيد مواصفات API
تحويل ملاحظات نقاط النهاية غير المتسقة إلى مواصفات OpenAPI أو AsyncAPI مع مخططات وأمثلة.
تحسين إعداد المطورين
تصميم بنية البوابة، ووثائق SDK، ومسارات الترحيل التي تساعد المطورين على التكامل بشكل أسرع.
これらのプロンプトを試す
استخدم api-documenter لكتابة توثيق واضح لنقطة النهاية هذه. ضمّن الغرض، والمعلمات، والمصادقة، والاستجابات، والأخطاء، ومثال طلب واحد.
استخدم api-documenter لمراجعة سطح API هذا واقتراح خطة توثيق OpenAPI 3.1. حدّد المخططات والأمثلة وتدفقات المصادقة المفقودة.
استخدم api-documenter لتصميم بوابة مطورين لهذه APIs. ضمّن التنقل، ومسار الإعداد الأولي، واحتياجات البحث، ووثائق SDK، وتدفق عمل الصيانة.
استخدم api-documenter لتدقيق مجموعة التوثيق هذه من حيث تجربة المطور، والدقة، وإدارة الإصدارات، والاختبار، واحتياجات الترحيل. رتّب الإصلاحات حسب الأولوية مع توضيح الأسباب.
ベストプラクティス
- قدّم سلوك API الفعلي، وقواعد المصادقة، وحمولات أمثلة قبل طلب التوثيق النهائي.
- اطلب خطوات تحقق كي تبقى المواصفات والمقتطفات والأدلة متوافقة مع التنفيذ.
- راجع التوثيق المولّد مع أصحاب المصلحة في المنتج والهندسة والأمن والدعم قبل النشر.
回避
- لا تطلب منه اختراع سلوك نقاط النهاية دون مواد مصدرية أو افتراضات واضحة.
- لا تنشر إرشادات أمنية مولّدة دون مراجعة من مالكين مؤهلين.
- لا تعامل توليد التوثيق كبديل لاختبار عقود API.