Revisor de Diseño de APIs
PROAudita APIs REST y GraphQL para verificar consistencia, escalabilidad, seguridad y cumplimiento de mejores prácticas antes del despliegue.
Ejemplo de Uso
Revisa este diseño de API REST para un servicio de gestión de usuarios. El endpoint es GET /api/v1/users/{id}/profile. Verifica la consistencia con las convenciones de nombres RESTful, valida los códigos de estado HTTP apropiados, confirma que la estructura de respuesta de error sigue el formato RFC 9457 Problem Details, y señala cualquier preocupación de seguridad como campos sensibles expuestos.
Prompt del Skill
Este skill funciona mejor cuando lo copias desde findskill.ai — incluye variables y formato que podrían no transferirse correctamente desde otros sitios.
Cómo Usar Este Skill
1
Copiar el skill usando el botón de arriba
2
Pegar en tu asistente de IA (Claude, ChatGPT, etc.)
3
Completa tus datos abajo (opcional) y copia para incluir con tu prompt
4
Envía y comienza a chatear con tu IA
Personalización Sugerida
| Descripción | Por defecto | Tu Valor |
|---|---|---|
| URL de la guía de estilo de API de tu organización para validación | https://opensource.zalando.com/restful-api-guidelines/ | |
| Registros por página por defecto para revisión de paginación | 20 | |
| Máximo de registros permitidos por petición | 1000 | |
| Mecanismo de autenticación requerido | oauth2 | |
| Puntuación máxima de complejidad de queries GraphQL | 1000 | |
| Ventana de tiempo para rate limiting | 3600 |
Audita APIs REST y GraphQL para verificar consistencia, escalabilidad, seguridad y cumplimiento de mejores prácticas. Obtén informes de revisión detallados con recomendaciones accionables antes del despliegue.
Fuentes de Investigación
Este skill fue creado usando investigación de estas fuentes autorizadas:
- Enhancing Data Query Flexibility with GraphQL Características de rendimiento GraphQL vs REST y optimización de esquemas
- REST API Design and Specification Practices Investigación empírica sobre desafíos reales de diseño de APIs
- Performance Evaluation of Microservices Communication Benchmark comparando rendimiento de REST, GraphQL y gRPC
- How to Conduct API Design Reviews Guía práctica sobre implementación de procesos de revisión de APIs
- API Design Patterns for Scalable Systems Patrones basados en recursos, paginación y enfoques de escalabilidad
- GraphQL API Design Best Practices Optimización de esquemas específica de GraphQL y manejo de errores
- API Design Reviews Don't Have to be Hard Metodología sistemática de revisión y evaluación de documentación
- OpenAPI Specification v3.1.0 Estándar oficial de descripción de APIs legible por máquinas