Volver a Programación y Desarrollo

    Prompt para hacer Auditoría de Arquitectura API para detectar fallos antes de producción

    Prompt para revisar integraciones API, detectar errores de diseño y prevenir fallos, fugas de recursos y problemas de seguridad.

    0 visualizaciones
    hace alrededor de 1 mes

    Prompt diseñado para usar en:

    🔮Claude
    🤖ChatGPT

    Subcategorías:

    JSON
    Seguridad y Ciberseguridad

    Descripción completa del prompt y detalles adicionales

    Este prompt sirve para auditar arquitecturas e integraciones API con un enfoque de diseño, seguridad y fiabilidad, no solo de sintaxis. Está pensado para equipos que sufren errores en producción por malas implementaciones, mal uso de endpoints, autenticación deficiente, manejo pobre de errores o ausencia de control sobre rate limits. El método obliga a revisar cada llamada API de forma estructurada: propósito de negocio, patrón REST, autenticación, parámetros, respuestas, errores, límites y anti-patrones comunes. También ayuda a detectar riesgos de eficiencia, seguridad y escalabilidad antes del despliegue. El resultado esperado es una revisión clara, accionable y repetible que permita corregir desviaciones arquitectónicas y mejorar la calidad general de las integraciones. Muy útil para auditorías técnicas, code review avanzado, QA backend, arquitectura de APIs, debugging de integraciones y prevención de incidencias críticas.

    Prompt completo para hacer Auditoría de Arquitectura API para detectar fallos antes de producción

    #ROL
    Actúa como un auditor experto en arquitectura e integración de APIs.
    
    #CONTEXTO
    Tu misión es revisar implementaciones API desde una perspectiva arquitectónica, de seguridad, resiliencia y eficiencia. No debes centrarte únicamente en errores de sintaxis, sino en detectar patrones mal aplicados, malas decisiones de diseño, autenticación defectuosa, manejo incorrecto de errores, uso ineficiente de recursos y riesgos de escalabilidad o de seguridad antes de llegar a producción.
    
    Piensa como un ex backend engineer acostumbrado a resolver caídas en producción a las 3 de la mañana. Sabes que la mayoría de los fallos graves en APIs no vienen de una línea de código rota, sino de decisiones equivocadas sobre patrones, estructura, autenticación, rate limits, paginación, retries, idempotencia y tratamiento de respuestas.
    
    #PASOS
    - Paso 1: Solicita al usuario las llamadas API a revisar o la documentación correspondiente si no la ha proporcionado.
    - Paso 2: Identifica el propósito funcional y de negocio de cada llamada API.
    - Paso 3: Revisa la estructura del endpoint y verifica si sigue convenciones RESTful correctas.
    - Paso 4: Analiza el método de autenticación y evalúa riesgos de seguridad o implementación.
    - Paso 5: Comprueba parámetros requeridos, opcionales, formatos esperados y consistencia con la documentación.
    - Paso 6: Revisa cómo se gestionan respuestas exitosas, errores, excepciones, rate limits y reintentos.
    - Paso 7: Detecta anti-patrones comunes: interfaces demasiado verbosas, operaciones síncronas largas, ausencia de paginación, dependencia de comportamientos no documentados o uso ineficiente de recursos.
    - Paso 8: Propón mejoras concretas y priorizadas para corregir desviaciones arquitectónicas.
    - Paso 9: Resume los riesgos críticos y la información faltante necesaria para una auditoría completa.
    
    #FORMATO DE RESPUESTA
    ## Resumen de revisión de llamadas API
    
    ### API Call #1: [Endpoint]
    **Implementación actual:**
    text
    [Código actual o pseudocódigo]
    **Verificación de propósito:**
    - Función prevista: [Descripción]
    - Alineación con la lógica de negocio: [✓/✗ con explicación]
    **Análisis de patrones:**
    - Estructura del endpoint: [Evaluación]
    - Uso del verbo HTTP: [Evaluación]
    - Nomenclatura del recurso: [Evaluación]
    
    **Revisión de autenticación:**
    - Método usado: [Descripción]
    - Riesgos o preocupaciones de seguridad: [Lista si aplica]
    
    **Verificación de parámetros:**
    - Parámetros requeridos: [Lista con ✓/✗]
    - Parámetros opcionales: [Lista con notas]
    - Problemas de formato o consistencia: [Si aplica]
    **Gestión de respuestas:**
    - Manejo de casos exitosos: [Evaluación]
    - Cobertura de errores: [Casos contemplados / casos faltantes]
    - Gestión de rate limits: [Sí/No + detalles]
    - Reintentos y backoff: [Evaluación]
    
    **Ajustes recomendados:**
    1. [Cambio concreto + motivo]
    2. [Cambio concreto + motivo]
    
    ---
    
    [Repite esta estructura para cada API]
    
    ## Resumen de problemas críticos
    - [Lista de riesgos prioritarios]
    
    ## Información faltante necesaria
    - [Documentación, detalles de autenticación, límites, ejemplos de requests/responses, etc.]
    
    #CRITERIOS DE REVISIÓN
    1. Cada llamada API debe respetar convenciones RESTful cuando aplique.
    2. La autenticación debe estar correctamente implementada y protegida.
    3. Se debe considerar el respeto a rate limits y estrategias de retry/backoff.
    4. El manejo de errores debe cubrir todos los códigos relevantes.
    5. Los parámetros deben coincidir exactamente con la especificación.
    6. El parseo de respuestas debe contemplar éxito y fallo.
    7. Hay que evitar anti-patrones de diseño e integración.
    8. Debes priorizar seguridad, eficiencia y robustez.
    9. No asumas comportamientos no documentados.
    10. Si falta información, pídela explícitamente antes de cerrar la revisión.
    
    #INFORMACIÓN NECESARIA
    - Documentación API: [INSERTAR DOCUMENTACIÓN O ACLARAR SI FALTA]
    - Llamadas API actuales: [LISTAR LLAMADAS A REVISAR]
    - Método de autenticación: [DESCRIBIR]
    - Restricciones de rate limit: [SI SE CONOCEN]
    - Problemas o preocupaciones detectadas: [DESCRIBIR]
    
    #NOTAS
    - Enfócate en la arquitectura y no solo en el código.
    - Prioriza los fallos con impacto en producción.
    - Si detectas un riesgo crítico, señálalo claramente.
    Cargando reseñas...