Agent skill · software engineering · affaan-m
api-design
Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de error, versionado y rate limiting para APIs de producción.
Why this skill is useful
Provides detailed conventions for REST API design that the AI wouldn't reliably generate on its own.
What it needs
About 7k tokens when loaded. Last updated 2026-08-06. 238,342 stars on the source repository.
What this skill does
Patrones de Diseño de API Convenciones y buenas prácticas para diseñar APIs REST consistentes y amigables para desarrolladores. Cuándo Activar Diseñar nuevos endpoints de API Revisar contratos de API existentes Agregar paginación, filtrado u ordenamiento Implementar manejo de errores para APIs Planificar la estrategia de versionado de API Construir APIs públicas o para partners Diseño de Recursos Estructura de URL Reglas de Nomenclatura Métodos HTTP y Códigos de Estado Semántica de Métodos Método Idempotente Seguro Usar Para -------- ----------- ------ --------- GET Sí Sí Recuperar recursos POST No No Crear recursos, disparar acciones PUT Sí No Reemplazo completo de un recurso PATCH No No Actualización parcial de un recurso DELETE Sí No Eliminar un recurso PATCH puede hacerse idempotente con la implementación adecuada Referencia de Códigos de Estado Errores Comunes Formato de Respuesta Respuesta Exitosa Respuesta de Colección (con Paginación) Respuesta de Error Variantes de Envelope de Respuesta Paginación Basada en Offset (Simple) Pros: Fácil de implementar, soporta "saltar a página N" Contras: Lento en offsets grandes (OFFSET 100000), inconsistente con inserciones concurrentes Basada en Cursor (Escalable) Pros: Rendimiento consistente independientemente de la posición, estable con inserciones concurrentes Contras: No se puede saltar a una página arbitraria, el cursor es opaco Cuándo Usar Cuál Caso de Uso Tipo de Paginación ---------- ---------------- Dashboards administrativos, datasets pequeños (<10K) Offset Scroll infinito, feeds, datasets grandes Cursor APIs públicas Cursor (por defecto) con offset (opcional) Resultados de búsqueda Offset (los usuarios esperan números de página) Filtrado, Ordenamiento y Búsqueda Filtrado Ordenamiento Búsqueda de Texto Completo Conjuntos de Campos Reducidos (Sparse Fieldsets) Autenticación y Autorización Autenticación Basada en Token Patrones de Autorización Rate Limiting Headers Niveles de Rate Limit Nivel Límite Ventana Caso d …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills affaan-m/api-design--57d88b