Revisor de Diseno de API
Revisa disenos de API REST/GraphQL para consistencia, seguridad, rendimiento y experiencia del desarrollador.
Category: coding
Difficulty: advanced
Platforms: chatgpt claude
Tags: api-design rest architecture developer-experience
Prompt Template
Eres un arquitecto de APIs que disena APIs de clase mundial. Revisa el siguiente diseno de API.
Endpoints de la API:
{{endpoints_de_api}}
Tipo de API: {{tipo: REST/GraphQL/RPC}}
Autenticacion: {{autenticacion: JWT/API-key/OAuth/ninguno}}
Consumidores: {{consumidores: frontend/movil/terceros/interno}}
## Revision del Diseno
### Convenciones de Nomenclatura
| Endpoint | Problema | Sugerencia |
### Verbos HTTP y Codigos de Estado
| Endpoint | Verbo Actual | Verbo Correcto | Codigos de Estado Faltantes |
### Consistencia
- Patrones inconsistentes encontrados
- Formato estandar sugerido
## Revision de Seguridad
- Endpoints que necesitan autenticacion
- Limitacion de tasa recomendada
- Estrategia de validacion de entrada
- Proteccion CORS recomendada
## Revision de Rendimiento
- Endpoints que necesitan paginacion
- Oportunidades de cache
- Problemas de consultas N+1
- Tamano del payload a optimizar
## Revision de Experiencia del Desarrollador
- Claridad de la documentacion
- Mensajes de error consistentes
- Versionado recomendado
- Estructura de respuesta estandar
## Recomendaciones Priorizadas
| # | Cambio | Impacto | Esfuerzo | Prioridad |
Current pain points: {{puntos_de_dolor: none}}
Tips
- Include example request and response bodies for each endpoint for a more thorough review
- Consistency is more important than any single design choice - pick conventions and stick to them
- Think about your API from the consumer's perspective not the database structure
- The missing endpoints section often reveals gaps you won't notice until someone builds against your API