Saltar a contenido

API Contract: [Nombre del Recurso]

Metadata

Campo Valor
Recurso
Base URL
Autor
Fecha
Estado
Spec relacionada

Convenciones Generales

Autenticacion

Content Type

Paginacion

Formato de Errores

{
  "error": {
    "code": "ERROR_CODE",
    "message": "Descripcion legible para el developer",
    "details": {}
  }
}

Endpoints

[METODO] [ruta]

Descripcion:

Autorizacion:

Request:

Headers: 

Authorization: Bearer <token>
Content-Type: application/json

Path params: | Param | Tipo | Requerido | Descripcion | |-------|------|-----------|-------------| | | | | |

Query params: | Param | Tipo | Requerido | Default | Descripcion | |-------|------|-----------|---------|-------------| | | | | | |

Body: 

{
  // Ejemplo del body
}

Response exitosa:

Status: 

{
  // Ejemplo de respuesta exitosa
}

Responses de error:

Status Code Cuando

Codigos de Error Especificos

Code HTTP Status Descripcion

Checklist de Completitud

  • Todos los endpoints documentados
  • Request y response con ejemplos concretos
  • Errores documentados con codigos especificos
  • Autorizacion especificada por endpoint
  • Paginacion documentada donde aplique
  • Revisada por frontend team
  • Revisada por otro ingeniero backend
  • Derivados generados (test plan / OpenAPI spec)

Archivos relacionados