27 lines
1.5 KiB
Markdown
27 lines
1.5 KiB
Markdown
# Contrato de la API (lo comparten web y app)
|
|
|
|
La especificación formal está en `openapi.yaml`. Este fichero la resume.
|
|
|
|
- API del escuadrón: `https://escuadron-1-api.tallerprompt.org`
|
|
- Web del escuadrón: `https://escuadron-1-web.tallerprompt.org`
|
|
|
|
| Método y ruta | Cuerpo | Respuestas |
|
|
|---|---|---|
|
|
| `GET /api/opciones` | — | `200` `["Ibiza","Praga"]` |
|
|
| `POST /api/votos` | `{"codigo": "A0001", "opcion": "Ibiza"}` | `201` voto guardado · `400` opción no válida · `403` código fuera del censo · `409` ese código ya ha votado |
|
|
| `GET /api/resultados` | — | `200` `{"Ibiza": 12, "Praga": 3, "total": 15}` (las dos opciones siempre, aunque tengan 0) |
|
|
| `GET /healthz` | — | `200` |
|
|
|
|
Reglas:
|
|
- El censo son los 600 códigos de `alumnos.csv`. Un voto por código.
|
|
- Las respuestas de error son JSON: `{"error": "mensaje corto"}`. Nunca trazas internas.
|
|
- La API debe permitir CORS desde la web del escuadrón (`https://escuadron-1-web.tallerprompt.org`).
|
|
|
|
## Niveles del árbitro (se proyectan en el marcador)
|
|
1. **El voto cuenta:** un voto válido responde 201 y aparece en los resultados.
|
|
2. **Un voto por alumno:** 409 al repetir, 403 fuera del censo, 400 con opción desconocida.
|
|
3. **El pucherazo:** la API resiste inyección SQL y no enseña trazas.
|
|
4. **El recreo:** muchos votos a la vez y el recuento sigue siendo exacto.
|
|
5. **Se cae un pod:** al reiniciarse la API, los votos siguen ahí.
|
|
6. **Web y API juntas:** desde la web se vota y se ve el resultado, sin errores de CORS ni de consola.
|