Título
Usa títulos cortos y claros que quepan en una línea en la tabla de contenidos (ToC). Sigue el patrón estándar de verbos:| Método | Verbo | Ejemplo |
|---|---|---|
POST | Crear | Crear una Cuenta |
GET | Listar | Listar cuentas |
GET (by ID) | Obtener | Obtener una Cuenta |
PATCH | Actualizar | Actualizar una Cuenta |
DELETE | Eliminar / Desactivar | Eliminar una Cuenta |
Descripción
Comienza con una explicación clara y concisa de lo que hace el endpoint y cuándo usarlo.Prerrequisitos
Lista lo que se requiere para usar el endpoint (por ejemplo, autenticación, permisos, entidades requeridas).Parámetros
Incluye todos los parámetros, agrupados por dónde aparecen:
- Parámetros de encabezado (Header)
- Parámetros de ruta (Path)
- Parámetros de consulta (Query)
Cuerpo (Payload)
Documenta todos los campos que aparecen en el cuerpo de la solicitud.| Campo | Tipo | Requerido | Descripción | Valores Posibles | Default | Restricciones | Ejemplo |
|---|---|---|---|---|---|---|---|
name | string | Yes | Nombre de la cuenta | — | — | MaxLength: 100 | "Cuenta principal" |
type | string | Yes | Tipo de cuenta | asset, liability | — | — | "asset" |
assetId | string | Yes | ID del activo associado | — | — | UUID | "01fbc1..." |
Respuestas exitosas
Describe lo que reciben los usuarios cuando la solicitud es exitosa. Incluye códigos de estado como200, 201 o 204.