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.
Installer avec mon Agent
Copiez cette demande dans votre Agent. Elle contient la page Skill de référence et le manifeste.
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.Votre Agent doit toujours présenter son plan et demander toute confirmation exigée par la politique de sécurité.
Ressources lisibles par les agents
Utilisez ces liens lorsqu’un Agent IA, un crawler ou un script a besoin d’un contexte propre au lieu de lire toute la page.
Tester
Utilisation de « api-and-interface-design ». Create a contract for a task service with create, list, update, and delete operations.
RĂ©sultat attendu:
- 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.
Utilisation de « api-and-interface-design ». Review a charge endpoint that checks for an idempotency key, charges a card, then stores the key.
RĂ©sultat attendu:
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.
Utilisation de « api-and-interface-design ». Plan a compatible addition of an optional priority field to task creation.
RĂ©sultat attendu:
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.
Audit de sécurité
SûrAll 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.
Facteurs de risque
⚙️ Commandes externes (46)
Partager et citer ce rapport
Partagez le rapport d’évaluation versionné, le badge neutre, la carte intégrable et les citations. Skillstore présente les preuves sans décider si ce Skill est sûr.
Copier le lien du rapport
https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/2?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportBadge Markdown
[](https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge)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>Carte intégrable
<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>Citations académiques (APA · BibTeX · CFF)
Citation 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/2Citation 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"
Score Skillstore
Pourquoi ce score Niveau de confiance des preuves: MoyenCe que vous pouvez créer
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.
Essayez ces prompts
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.
Bonnes pratiques
- 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.
Éviter
- 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.
Foire aux questions
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?
Détails du développeur
Auteur
addyosmaniLicence
MIT
RĂ©vision Skillstore
r2
Avis de version
L’auteur n’a déclaré aucune version.
RĂ©f
5d5054f8a23586f9b500fece1cb613a9dffc787b
RĂ©cence de maintenance
19/09/2026
Utilisation
0 téléchargements · 0 vues
Structure de fichiers
đź“„ SKILL.md