Anmolop97/Agent-Skills

Domina los principios de diseño de API REST y GraphQL para construir APIs intuitivas, escalables y mantenibles que deleiten a los desarrolladores. Úsalo al diseñar nuevas APIs, revisar especificaciones o establecer estándares de diseño de API.

¿Qué es Agent-Skills?

Esta habilidad está diseñada para desarrolladores y equipos que trabajan con APIs REST y GraphQL, proporcionando una guía completa para construir interfaces de programación de aplicaciones bien diseñadas y fáciles de mantener. Su objetivo es ayudar a crear APIs intuitivas, escalables y que resulten agradables para los desarrolladores que las consumen. Basada en las mejores prácticas de la industria, la habilidad cubre principios fundamentales como la definición de consumidores, casos de uso y restricciones, la elección del estilo de API adecuado, el modelado de recursos, la especificación de errores, versionado, paginación y estrategias de autenticación. Es útil en diversas situaciones, desde el diseño de nuevas APIs hasta la refactorización de existentes, el establecimiento de estándares de diseño en equipo o la revisión de especificaciones antes de la implementación. La habilidad también sugiere recursos adicionales, como una guía de implementación detallada con patrones, listas de verificación y plantillas, que se encuentra en el archivo `resources/implementation-playbook.md`. Es importante no utilizar esta habilidad cuando solo se necesita orientación de implementación para un framework específico, para trabajo exclusivo de infraestructura sin contratos de API, o cuando no es posible cambiar o versionar interfaces públicas.

Compatible con~Claude Code~Codex CLI~Cursor

npx skills add https://github.com/Anmolop97/Agent-Skills/tree/HEAD/skills/api-design-principles

Documentación

Principios de Diseño de API

Domina los principios de diseño de API REST y GraphQL para construir APIs intuitivas, escalables y mantenibles que deleiten a los desarrolladores y resistan el paso del tiempo.

Usa esta habilidad cuando

Estés diseñando nuevas APIs REST o GraphQL
Estés refactorizando APIs existentes para mejorar su usabilidad
Estés estableciendo estándares de diseño de API para tu equipo
Estés revisando especificaciones de API antes de la implementación
Estés migrando entre paradigmas de API (de REST a GraphQL, etc.)
Estés creando documentación de API amigable para desarrolladores
Estés optimizando APIs para casos de uso específicos (móvil, integraciones de terceros)

No uses esta habilidad cuando

Solo necesites orientación de implementación para un framework específico
Estés realizando trabajo exclusivo de infraestructura sin contratos de API
No puedas cambiar o versionar interfaces públicas

Instrucciones

Define consumidores, casos de uso y restricciones.
Elige el estilo de API y modela los recursos o tipos.
Especifica errores, versionado, paginación y estrategia de autenticación.
Valida con ejemplos y revisa para asegurar consistencia.

Consulta el archivo resources/implementation-playbook.md para patrones detallados, listas de verificación y plantillas.

Recursos

resources/implementation-playbook.md para patrones detallados, listas de verificación y plantillas.