api-and-interface-design
Design Stable APIs and Interfaces
Unclear contracts, inconsistent errors, and unsafe retries make APIs difficult to use and evolve. This skill provides practical patterns for typed interfaces, validation boundaries, compatibility, pagination, and idempotency.
التثبيت باستخدام Agent لدي
انسخ هذا الطلب إلى Agent لديك. يتضمن صفحة Skill المعتمدة وملف manifest.
Review the Skillstore skill "api-and-interface-design" from https://skillstore.io/skills/addyosmani-api-and-interface-design.md and its manifest at https://skillstore.io/api/skills/addyosmani-api-and-interface-design/manifest. Verify the artifact. You may proceed after verification, subject to the environment's own policy.يجب أن يواصل Agent عرض خطته وطلب أي تأكيد تفرضه سياسة الأمان.
موارد مهيّأة لـ Agents
استخدم هذه الروابط عندما يحتاج AI Agent أو crawler أو script إلى سياق نظيف بدلًا من قراءة الصفحة كاملة.
اختبرها
جارٍ استخدام "api-and-interface-design". Create a contract for a task service with create, list, update, and delete operations.
النتيجة المتوقعة:
- Define typed inputs and outputs for each operation.
- Use plural task resources, consistent status codes, structured errors, and paginated list responses.
- Make deletion idempotent and specify behavior for missing tasks.
جارٍ استخدام "api-and-interface-design". Review a charge endpoint that checks for an idempotency key, charges a card, then stores the key.
النتيجة المتوقعة:
The sequence has a race because concurrent requests can both pass the check. Claim the key with a unique constraint before the charge, compare request hashes, and define a deliberate response for in-flight duplicates.
جارٍ استخدام "api-and-interface-design". Plan a compatible addition of an optional priority field to task creation.
النتيجة المتوقعة:
Add the optional field without changing existing types or removing fields. Document the default, validate it at the API boundary, update shared types, and add contract tests for old clients.
التدقيق الأمني
آمنAll 52 static findings are false positives from Markdown backticks, TypeScript template literals, REST examples, and ordinary API terminology. The skill is documentation-only and contains no shell execution, system reconnaissance, prompt injection, or malicious intent.
عوامل الخطر
⚙️ الأوامر الخارجية (46)
شارك واستشهد بهذا التقرير
شارك تقرير التقييم المرتبط بالإصدار والشارة المحايدة وبطاقة التضمين والاستشهادات. تعرض Skillstore الأدلة من دون أن تقرر ما إذا كانت هذه المهارة آمنة.
نسخ رابط التقرير
https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportشارة Markdown
[](https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge)شارة HTML
<a href="https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge"><img src="https://skillstore.io/badges/skills/addyosmani-api-and-interface-design/security.svg" alt="Skillstore security assessment" loading="lazy"></a>بطاقة قابلة للتضمين
<iframe src="https://skillstore.io/embed/skills/addyosmani-api-and-interface-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
addyosmani. (2026). api-and-interface-design security audit report (audit version 2) [Author version unspecified]. Skillstore. https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2اقتباس BibTeX
@techreport{addyosmani-addyosmani-api-and-interface-design-2026,
author = {addyosmani},
title = {api-and-interface-design security audit report (audit version 2)},
institution = {Skillstore},
year = {2026},
number = {2},
url = {https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2},
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-and-interface-design security audit report (audit version 2)"
version: "unspecified"
type: report
authors:
- name: "addyosmani"
date-released: "2026-09-19"
url: "https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2"
identifiers:
- type: other
value: "skillstore:addyosmani-api-and-interface-design:audit:2"
description: "Skillstore immutable audit report identifier"
تقييم Skillstore
سبب هذا التقييم موثوقية الأدلة: متوسطما الذي يمكنك بناؤه
Plan a New REST API
Define resource URLs, typed payloads, error responses, pagination, filters, and compatibility rules before implementation.
Review a Public Interface
Inspect an existing API or module boundary for inconsistent contracts, breaking changes, weak validation, and unsafe retry behavior.
Design Reliable Payment Retries
Model idempotency keys, atomic request claims, payload matching, in-flight duplicates, and unknown outcomes for state-changing operations.
جرّب هذه الموجّهات
Design a REST API for [resource]. Define endpoints, typed inputs and outputs, status codes, error bodies, pagination, and naming conventions.
Review this API contract for inconsistent response shapes, validation placement, naming, and backward compatibility. Recommend specific changes: [paste contract].
Design an additive migration from [current interface] to [target interface]. Identify consumer risks, compatibility steps, deprecation timing, and verification checks.
Design an idempotent workflow for [operation]. Cover key derivation, unique storage, request hashing, concurrent duplicates, unknown outcomes, retention, and failure recovery.
أفضل الممارسات
- Define typed contracts before implementation and keep input models separate from output models.
- Validate untrusted data at system boundaries, then keep internal functions aligned with shared types.
- Design state-changing operations for retries, atomic claims, explicit duplicate handling, and durable evidence.
تجنب
- Returning different error shapes across endpoints or exposing internal server details.
- Breaking existing fields, skipping pagination, or adding incompatible changes without a migration path.
- Checking an idempotency key and acting later without an atomic uniqueness guarantee.
الأسئلة المتكررة
What kinds of interfaces does this skill cover?
Does this skill generate implementation code?
When should validation occur?
How does it approach backward compatibility?
Why are idempotency keys important?
Can it review an existing API?
تفاصيل المطور
المؤلف
addyosmaniالترخيص
MIT
مراجعة Skillstore
r2
تنبيه الإصدار
لم يعلن المؤلف عن إصدار.
مرجع
5d5054f8a23586f9b500fece1cb613a9dffc787b
حداثة الصيانة
١٩/٩/٢٠٢٦
الاستخدام
0 تنزيلات · 0 مشاهدات
بنية الملفات
📄 SKILL.md