Volver al curso

Node.js y APIs con Express

leccion
12 / 12
beginner
10 horas
Produccion

Documentar tu API: contratos y ejemplos

Lectura
15 min~1 min lectura

Documentacion

Una API sin docs es soporte infinito. Documenta endpoints, inputs, outputs y errores.

Conceptos clave

  • OpenAPI (idea)
  • Ejemplos reales de request/response
  • Errores documentados

Ejemplo

Documenta al menos: POST /signup, GET /me, GET /items.

Ejercicio

  • Escribe docs de 1 endpoint con ejemplos.
  • Incluye 2 casos de error.

Checklist de mastery

  • Mis endpoints tienen ejemplos.
  • Los errores estan documentados.