スキル api-documentation
📦

api-documentation

コンテンツリビジョン r1 安全 ⚙️ 外部コマンド🌐 ネットワークアクセス🔑 環境変数

إنشاء توثيق API

تحتاج فرق API إلى وثائق دقيقة تطابق نقاط النهاية والأمثلة المتغيرة. تساعد هذه المهارة Claude وCodex وClaude Code على إنشاء مراجع وأدلة وتوثيق تفاعلي.

対応: Claude Codex Code(CC)
Maintain this Skill? Claim it 🥉 77 ブロンズ

自分のエージェントでインストール

このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。

エージェントリクエスト
Review the Skillstore skill "api-documentation" from https://skillstore.io/skills/curiouslearner-api-documentation.md and its manifest at https://skillstore.io/api/skills/curiouslearner-api-documentation/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.

エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。

エージェントが読めるリソース

AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。

テストする

「api-documentation」を使用しています。 مواصفة OpenAPI لنقاط نهاية المستخدمين والمؤسسات والمصادقة والفوترة.

期待される結果:

  • مرجع نقاط نهاية مجمّع حسب المورد.
  • دليل المصادقة والتعامل مع الرموز.
  • أقسام الأخطاء وترقيم الصفحات وحدود المعدلات.
  • أمثلة بلغات متعددة للطلبات الشائعة.

「api-documentation」を使用しています。 تعليقات كود موجودة لخدمة TypeScript أو Python.

期待される結果:

مسودة منظمة تتضمن ملخصات نقاط النهاية وأوصاف المعلمات وملاحظات الاستجابة وأسئلة التوثيق الناقص.

「api-documentation」を使用しています。 طلب لنشر وثائق تفاعلية لبوابة مطورين.

期待される結果:

خطة إعداد تقارن أدوات التوثيق والأصول المطلوبة وخطوات الاستضافة وفحوصات المراجعة قبل الإصدار.

セキュリティ監査

安全

Static findings were caused by Markdown code fences, example commands, placeholder API keys, and sample HTTP requests in SKILL.md. No evidence of prompt injection, credential exfiltration, obfuscated code, or automatic command execution was found.

1
スキャンされたファイル
888
解析済み行数
0
レビュー項目
0
誤検知を無視

リスク要因

⚙️ 外部コマンド (87)
🌐 ネットワークアクセス (35)
🔑 環境変数 (7)
最新の完了済み静的・セマンティック監査では、確認済みのセキュリティ検出事項は見つかりませんでした。これは、スキルに副作用がないことを証明するものではありません。
監査者: codex 監査履歴を表示 →
このレポートを共有・引用

バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。

バージョン別レポートを開く
セキュリティ評価

レポートリンクをコピー

https://skillstore.io/skills/curiouslearner-api-documentation/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_report

Markdownバッジ

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

HTMLバッジ

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

埋め込みカード

<iframe src="https://skillstore.io/embed/skills/curiouslearner-api-documentation.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形式の引用

CuriousLearner. (2026). api-documentation security audit report (audit version 8) [Author version unspecified]. Skillstore. https://skillstore.io/skills/curiouslearner-api-documentation/audits/8

BibTeX形式の引用

@techreport{curiouslearner-curiouslearner-api-documentation-2026, author = {CuriousLearner}, title = {api-documentation security audit report (audit version 8)}, institution = {Skillstore}, year = {2026}, number = {8}, url = {https://skillstore.io/skills/curiouslearner-api-documentation/audits/8}, 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-documentation security audit report (audit version 8)" version: "unspecified" type: report authors: - name: "CuriousLearner" date-released: "2026-07-05" url: "https://skillstore.io/skills/curiouslearner-api-documentation/audits/8" identifiers: - type: other value: "skillstore:curiouslearner-api-documentation:audit:8" description: "Skillstore immutable audit report identifier"

バリアントを比較

インストール可能なバリアント 3 件

各作者のスキルは個別のインストール項目として維持されます。推奨バリアントは Skillstore の証拠で順位付けされます。

このバリアントが首位の理由

Skillstore での利用が多い
supercent-io 推奨

supercent-io-api-documentation

Skillstore スコア 78
証拠の信頼度 高
Skillstore 利用状況 22
更新済み

2026-09-09

sickn33-api-documentation

Skillstore スコア 78
証拠の信頼度 高
Skillstore 利用状況 16
更新済み

2026-09-09

curiouslearner-api-documentation

Skillstore スコア 77
証拠の信頼度 高
Skillstore 利用状況 24
更新済み

2026-09-09

Skillstore スコア

このスコアの理由 証拠の信頼度: 高
55
アーキテクチャ
85
保守性
87
コンテンツ
72
コミュニティ
74
仕様準拠

作成できるもの

توثيق API جديد

أنشئ صفحات مرجعية وأمثلة طلبات ومخططات وملاحظات رموز الحالة من مواصفة OpenAPI.

إعداد أدلة المطورين

حوّل تفاصيل نقاط النهاية إلى أدلة للبدء والمصادقة ومعالجة الأخطاء وترقيم الصفحات وحدود المعدلات.

إطلاق وثائق تفاعلية

خطط لتوثيق Swagger UI أو Redoc أو Stoplight Elements مع طلبات نموذجية وخطوات النشر.

これらのプロンプトを試す

إنشاء مرجع أساسي
أنشئ مرجع API لهذه المواصفة OpenAPI. تضمّن نقاط النهاية والمعلمات والمخططات والاستجابات وأمثلة طلبات واضحة.
إضافة أدلة التهيئة الأولية
أنشئ توثيق البدء والمصادقة ومعالجة الأخطاء وترقيم الصفحات وحدود المعدلات لمرجع API هذا.
بناء وثائق تفاعلية
صمّم إعداد توثيق تفاعلي لهذا API. قارن Swagger UI وRedoc وStoplight Elements لهذا المشروع.
تخطيط النشر متعدد التنسيقات
أنشئ خطة نشر لمخرجات توثيق Markdown وHTML ومجموعة Postman وSDK. تضمّن خطوات التحقق والمراجعة.

ベストプラクティス

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

回避

  • نشر الوثائق المُنشأة دون التحقق من تفاصيل المصادقة والأخطاء وحدود المعدلات.
  • خلط الأسرار الحقيقية داخل الأمثلة أو لقطات الشاشة.
  • استخدام ميزات try-it-out التفاعلية ضد نقاط نهاية الإنتاج دون حدود.

よくある質問

ما أفضل المدخلات لهذه المهارة؟
تعمل ملفات OpenAPI أو Swagger بشكل أفضل. يمكن لتعليقات الكود وقوائم المسارات والوثائق الموجودة أيضًا أن توفر بنية مفيدة.
هل يمكنها إنشاء توثيق تفاعلي؟
نعم. يمكنها تخطيط إعدادات Swagger UI وRedoc وStoplight Elements مع ملاحظات تهيئة خاصة بالمشروع.
هل تتحقق من سلوك API المباشر؟
لا. يجب اختبار الأمثلة المُنشأة مقابل خدمة مرحلية قبل النشر.
هل يمكنها المساعدة في توثيق SDK؟
نعم. يمكنها توضيح خطوات إنشاء SDK وكتابة وثائق الاستخدام للعملاء المُنشأين.
هل تتعامل مع مفاتيح API بأمان؟
تستخدم عناصر نائبة في الأمثلة. لا تلصق بيانات اعتماد حقيقية في المطالبات أو الأمثلة أو الوثائق المنشورة.
هل ستشغّل أوامر الإعداد تلقائيًا؟
لا. إنها توفر إرشادات الإعداد. يجب على المستخدمين الموافقة على أوامر المشروع وتشغيلها فقط عندما يختارون ذلك.

開発者情報

作成者

CuriousLearner

ライセンス

MIT

Skillstore リビジョン

r1

バージョンに関する注意

作者はバージョンを宣言していません。

参照

02f077c174c5335e2f5d02ca15e77b70d9543e58

メンテナンスの新しさ

2026/7/21

利用状況

11 ダウンロード · 337 閲覧

ファイル構成

📄 SKILL.md