api-and-interface-design
Design Stable APIs and Interfaces
Inconsistent interfaces create fragile integrations and costly breaking changes. This skill guides contract-first design, predictable errors, validation, compatibility, pagination, and reliable idempotency.
Instalar con mi Agente
Copia esta solicitud en tu Agente. Incluye la página canónica del Skill y el manifiesto.
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.Tu Agente debe seguir mostrando su plan y solicitar cualquier confirmación exigida por la política de seguridad.
Recursos legibles por agentes
Usa estos enlaces cuando un agente de IA, crawler o script necesite contexto limpio en vez de leer la página completa.
Pruébalo
Usando "api-and-interface-design". Design task-management endpoints for web and mobile clients.
Resultado esperado:
- A resource map covering task creation, listing, retrieval, partial updates, deletion, and comments.
- A consistent error contract with validation, authorization, conflict, and server failure semantics.
- A pagination and filtering policy with stable field naming.
Usando "api-and-interface-design". Review an endpoint that charges a card and accepts retries.
Resultado esperado:
- A client-owned idempotency key tied to one payment intent.
- An atomic uniqueness claim with request payload verification.
- Defined responses for completed, in-flight, failed, and unknown outcomes.
- A retention period based on the longest possible retry path.
Auditoría de seguridad
SeguroAll 52 static findings are false positives caused by Markdown code fences, inline code, TypeScript template literals, ordinary API examples, and prose. The skill contains guidance and illustrative code only, with no executable shell commands, reconnaissance behavior, prompt injection, or malicious intent.
Factores de riesgo
⚙️ Comandos externos (46)
Compartir y citar este informe
Comparte el informe de evaluación versionado, la insignia neutral, la tarjeta insertable y las citas. Skillstore presenta evidencias sin decidir si este Skill es seguro.
Copiar enlace del informe
https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/1?utm_source=security_passport&utm_medium=share&utm_campaign=versioned_reportInsignia Markdown
[](https://skillstore.io/skills/addyosmani-api-and-interface-design?utm_source=security_passport_badge)Insignia 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>Tarjeta para insertar
<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>Citas académicas (APA · BibTeX · CFF)
Cita APA
addyosmani. (2026). api-and-interface-design security audit report (audit version 1) [Author version unspecified]. Skillstore. https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/1Cita BibTeX
@techreport{addyosmani-addyosmani-api-and-interface-design-2026,
author = {addyosmani},
title = {api-and-interface-design security audit report (audit version 1)},
institution = {Skillstore},
year = {2026},
number = {1},
url = {https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/1},
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 1)"
version: "unspecified"
type: report
authors:
- name: "addyosmani"
date-released: "2026-09-13"
url: "https://skillstore.io/skills/addyosmani-api-and-interface-design/audits/1"
identifiers:
- type: other
value: "skillstore:addyosmani-api-and-interface-design:audit:1"
description: "Skillstore immutable audit report identifier"
Puntuación de Skillstore
Por qué esta puntuación Confianza de la evidencia: MedioLo que puedes crear
Define a New Service Contract
Create predictable resources, request schemas, response schemas, errors, and pagination before implementation begins.
Review a Public Interface Change
Identify breaking changes and redesign them as additive updates with clear migration behavior.
Align Cross-Team Boundaries
Establish typed contracts, naming conventions, validation ownership, and retry semantics between frontend and backend teams.
Prueba estos prompts
Design REST endpoints for [resource]. Include methods, paths, request fields, response fields, status codes, and pagination.
Create a contract-first interface for [feature]. Separate inputs from outputs and define one consistent error model.
Review this interface change: [change]. Identify observable behavior, breaking risks, and additive alternatives for existing consumers.
Design idempotency for [operation]. Cover key ownership, atomic claiming, payload hashes, in-flight duplicates, unknown outcomes, and retention.
Mejores prácticas
- Define inputs, outputs, errors, and observable behavior before implementation.
- Validate untrusted data at system boundaries and keep internal contracts typed.
- Prefer additive optional fields and document deprecation before removing behavior.
Evitar
- Mixing error shapes or failure strategies across related endpoints.
- Changing public field types or removing fields without a migration plan.
- Implementing idempotency with a separate existence check and side effect.
Preguntas frecuentes
Does this skill support REST and GraphQL?
Can it design TypeScript interfaces?
Does it create implementation code?
How does it handle breaking changes?
What idempotency topics are covered?
Does it perform security testing?
Detalles del desarrollador
Autor
addyosmaniLicencia
MIT
Revisión de Skillstore
r1
Aviso de versión
El autor no declaró una versión.
Ref.
5526951beaeca22519572a471618555839b53b05
Actualidad del mantenimiento
14/9/2026
Uso
0 descargas · 0 vistas
Estructura de archivos
📄 SKILL.md