api-contract-design
تصميم عقود OpenAPI بمنهجية المخطط أولاً
تخسر فرق واجهات API الوقت عندما تكون العقود غير واضحة أو تُكتب بعد التنفيذ. ترشد هذه المهارة إلى تصميم OpenAPI أولاً، وتوليد TypeScript، والتحقق، والتوثيق، وسير عمل النماذج الوهمية.
自分のエージェントでインストール
このリクエストをエージェントにコピーしてください。正規の Skill ページとマニフェストが含まれています。
Review the Skillstore skill "api-contract-design" from https://skillstore.io/skills/doyajin174-api-contract-design.md and its manifest at https://skillstore.io/api/skills/doyajin174-api-contract-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.エージェントは引き続き計画を提示し、セキュリティポリシーで必要な確認を求める必要があります。
エージェントが読めるリソース
AI エージェント、クローラー、スクリプトがページ全体ではなく整理されたコンテキストを必要とする場合は、これらのリンクを使ってください。
テストする
「api-contract-design」を使用しています。 يحتاج فريق إلى API لإدارة المستخدمين قبل بدء عمل backend.
期待される結果:
- مخطط عام لعقد OpenAPI يتضمن أقسام المستخدمين والمصادقة والتقسيم إلى صفحات والأخطاء.
- قائمة مراجعة لفرق frontend وbackend.
- خطة توليد الأنواع لنماذج العملاء المشتركة.
「api-contract-design」を使用しています。 خدمة قديمة تفتقر إلى عملاء ذوي أنواع محددة.
期待される結果:
خطة ترحيل تربط نقاط النهاية بعمليات OpenAPI، ثم تولد أنواع TypeScript وعميلاً.
「api-contract-design」を使用しています。 تطوير frontend متوقف بسبب نقاط نهاية backend مفقودة.
期待される結果:
سير عمل لخادم وهمي باستخدام العقد، وأمثلة مشتركة، وخطوات مراجعة لتغييرات API.
セキュリティ監査
安全All static findings were adjudicated as false positives in documentation examples, reference links, or OpenAPI schema snippets. No prompt injection, credential exfiltration, unauthorized command execution, or malicious network intent was found in SKILL.md or marketplace.json.
リスク要因
⚙️ 外部コマンド (41)
🌐 ネットワークアクセス (9)
📁 ファイルシステムへのアクセス (2)
🔑 環境変数 (2)
このレポートを共有・引用
バージョン付き評価レポート、中立的なバッジ、埋め込みカード、引用を共有できます。Skillstore は証拠を報告しますが、この Skill が安全かどうかは判断しません。
レポートリンクをコピー
https://skillstore.io/skills/doyajin174-api-contract-design/audits/8?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportMarkdownバッジ
[](https://skillstore.io/skills/doyajin174-api-contract-design?utm_source=security_passport_badge)HTMLバッジ
<a href="https://skillstore.io/skills/doyajin174-api-contract-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/doyajin174-api-contract-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>埋め込みカード
<iframe src="https://skillstore.io/embed/skills/doyajin174-api-contract-design.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形式の引用
Doyajin174. (2026). api-contract-design security audit report (audit version 8) [Author version 1.0]. Skillstore. https://skillstore.io/skills/doyajin174-api-contract-design/audits/8BibTeX形式の引用
@techreport{doyajin174-doyajin174-api-contract-design-2026,
author = {Doyajin174},
title = {api-contract-design security audit report (audit version 8)},
institution = {Skillstore},
year = {2026},
number = {8},
url = {https://skillstore.io/skills/doyajin174-api-contract-design/audits/8},
note = {Author version 1.0}
}CITATION.cff
cff-version: 1.2.0
message: "If you use this Skill, cite its author and this versioned security audit report."
title: "api-contract-design security audit report (audit version 8)"
version: "1.0"
type: report
authors:
- name: "Doyajin174"
date-released: "2026-07-06"
url: "https://skillstore.io/skills/doyajin174-api-contract-design/audits/8"
identifiers:
- type: other
value: "skillstore:doyajin174-api-contract-design:audit:8"
description: "Skillstore immutable audit report identifier"
Skillstore スコア
このスコアの理由 証拠の信頼度: 高作成できるもの
تخطيط API لمنتج جديد
تعريف نقاط النهاية ونماذج البيانات واستجابات الأخطاء وأنواع العملاء قبل بدء التنفيذ.
توثيق خدمة REST قائمة
تحويل السلوك الحالي إلى عقد OpenAPI يمكن للفرق مراجعته وصيانته.
توحيد عقود الخدمات
إنشاء أنماط متسقة للتقسيم إلى صفحات والأخطاء والإصدارات والتحقق وحزم SDK المولدة عبر الخدمات.
これらのプロンプトを試す
صمم عقد OpenAPI 3.1 لواجهة todo API. ضمّن نقاط نهاية CRUD ومخططات الطلبات والاستجابات والأخطاء الشائعة.
وسّع عقد API هذا بمخططات قابلة لإعادة الاستخدام ومعرفات العمليات. اشرح كيفية توليد أنواع TypeScript والتحقق من الطلبات.
أنشئ سير عمل بمنهجية المخطط أولاً لفرق frontend وbackend. ضمّن استخدام الخادم الوهمي والمراجعات وإدارة الإصدارات ونشر التوثيق.
راجع عقد OpenAPI هذا من حيث قابلية الصيانة والتغييرات الكاسرة والمخططات المكررة وضعف التحقق ومخاطر توليد الكود. اقترح تحسينات مرتبة حسب الأولوية.
ベストプラクティス
- الاتفاق على معرفات العمليات وأشكال الاستجابات ونماذج الأخطاء قبل بدء التنفيذ.
- الحفاظ على العقود الكبيرة بشكل معياري باستخدام مخططات واستجابات ومراجع مسارات قابلة لإعادة الاستخدام.
- مراجعة عقود API مثل كود الإنتاج قبل توليد العملاء أو حزم SDK.
回避
- لا تخلط بين مصادر المخطط أولاً والكود أولاً دون قاعدة ملكية واضحة.
- لا تخفِ التغييرات الكاسرة خلف تسميات الإصدارات دون ملاحظات ترحيل.
- لا تولد العملاء من عقود غير مراجعة أو مواصفات قديمة.
よくある質問
هل تشغّل هذه المهارة أدوات OpenAPI تلقائياً؟
ما إصدار OpenAPI الذي تستهدفه؟
هل يمكنها المساعدة مع واجهات API القائمة؟
هل تحل محل التحقق في backend؟
هل يمكن لـ Claude أو Codex أو Claude Code استخدامها؟
هل هي مفيدة للعملاء المولدين؟
開発者情報
作成者
Doyajin174ライセンス
MIT
作者バージョン
v1.0
Skillstore リビジョン
r1
バージョンに関する注意
作者が宣言したバージョンは有効な SemVer ではありません。
参照
72d5025b022c77f7a51bdf5c1637c689c80e89d1
メンテナンスの新しさ
2026/7/20
利用状況
6 ダウンロード · 261 閲覧
ファイル構成