¿Qué hace esta skill?

La Diseño de APIs REST Skill proporciona un conjunto de convenciones y mejores prácticas para diseñar APIs REST consistentes, robustas y fáciles de consumir. Resuelve problemas comunes de nomenclatura de recursos, manejo de errores, paginación y versionado, garantizando que cualquier API nueva o existente siga un contrato predecible y orientado al desarrollador.

Diseño de nuevos endpoints
Define recursos, URLs y métodos HTTP al crear nuevos servicios backend desde cero.
Revisión de contratos existentes
Audita APIs ya construidas para asegurar consistencia en nomenclatura, errores y respuestas.
Manejo de errores y paginación
Implementa formatos de error estandarizados y paginación basada en cursor en colecciones grandes.
Estrategia de versionado
Planifica el versionado de la API con /api/v1/ y gestiona breaking changes de forma controlada.

Ejemplos de uso

🆕 Diseño desde cero
Necesito diseñar una API REST para gestionar pedidos de una tienda online. Define los endpoints, métodos y formato de respuestas.
🔍 Revisión de consistencia
Revisa estos endpoints de mi API actual y dime si siguen buenas prácticas de nomenclatura y semántica HTTP.
📄 Formato de errores
Diseña un formato de respuesta de error estandarizado para mi API con códigos, mensajes y detalles de validación.
🔄 Estrategia de versionado
Ayúdame a planificar el versionado de mi API pública. ¿Cuándo debo pasar de v1 a v2?

Características

Nomenclatura de recursos Sustantivos en plural, minúsculas y kebab-case para URLs predecibles y orientadas al desarrollador.
Semántica HTTP completa Uso correcto de GET, POST, PUT, PATCH y DELETE según la intención de cada operación.
Respuestas estandarizadas Envoltura con objeto data para éxitos y objeto error con códigos y detalles para fallos.
Paginación por cursor Paginación eficiente para grandes conjuntos de datos con metadatos y enlaces de navegación.
Versionado y seguridad Estrategia de versionado con /api/v1/ y autenticación mediante tokens Bearer con autorización a nivel de recurso.

Preguntas frecuentes

No. Esta skill es una guía de patrones y convenciones. Funciona directamente con Claude Code o Cowork sin configuración adicional.
La skill incluye ejemplos en TypeScript con Next.js API Routes y validación con Zod, pero las convenciones son aplicables a cualquier lenguaje o framework.
Sí. Las convenciones cubren tanto APIs internas como públicas y de socio (partner-facing), incluyendo seguridad con Bearer tokens.
Por supuesto. La skill sirve como base de buenas prácticas; puedes ajustar los patrones según las necesidades específicas de tu equipo.

Skills relacionadas

Mas skills de la misma categoria:

Diseño de APIs REST — APIs consistentes y robustas con Claude AI

¿Prefieres escuchar el contenido? Genera la narración de audio con un clic.