Deploy, documentacion y proyecto final

Una entrega operable explica cómo preparar, ejecutar y comprobar la API sin depender de conocimiento oral. La documentación debe distinguir configuración, migraciones, pruebas, health check y comportamiento de errores. Las variables sensibles se describen por nombre y formato, nunca con valores reales.

Ejemplo resuelto

Un README puede indicar DATABASE_URL, el comando de migración, el comando de pruebas y GET /health. Si la aplicación responde {status:"ok"} en salud, esa ruta no debe afirmar que la base está disponible si no la comprueba. El procedimiento de recuperación debe decir qué revisar ante una migración fallida, sin borrar datos a ciegas.

Separa /health (proceso activo) de /ready (dependencias necesarias disponibles). Una readiness que no logra una consulta de prueba debe devolver 503. Genera el cliente de Prisma y prueba las migraciones en una base de laboratorio antes de aplicarlas; prisma migrate deploy aplica migraciones existentes y no sustituye la generación del cliente. Planifica la compatibilidad entre aplicación y esquema antes de llamar “rollback” a volver al código anterior.

Pruébalo

1. Lista variables necesarias y cuáles son secretas.

2. Documenta preparación de base y migraciones.

3. Añade ejemplos de requests y respuestas.

4. Ejecuta health check, pruebas y revisión de logs.

Error frecuente: documentar solo el caso exitoso. Corrígelo incluyendo 400, 401, 403, 404 y un fallo interno esperado.

Comprueba tu resultado

Otra persona debe poder identificar el comando de pruebas, la ruta de salud y la respuesta esperada sin preguntarte. El README no debe contener tokens, contraseñas ni una URL privada real; la ejecución debe producir una matriz de casos reproducible.