Hipermedia y HATEOAS
🎯 Objetivo​
6.1: Todas las respuestas de la API deben incluir enlaces HATEOAS en un formato consistente:
{
"data": {
// Datos del recurso
},
"_links": [
{
"rel": "self",
"href": "/api/v1/resources/{id}",
"method": "GET"
},
{
"rel": "related",
"href": "/api/v1/resources/{id}/related",
"method": "GET"
}
]
}
6.2: Los enlaces deben ser absolutos y deben incluir la versión de la API.
6.3: Se deben incluir enlaces a recursos relacionados cuando sea apropiado.
6.4: Los enlaces deben ser descubribles y autoexplicativos.
6.5: Se debe incluir un enlace self en todas las respuestas.
6.6: Los enlaces deben seguir las convenciones de nombrado establecidas en la documentación.
6.7: Se deben incluir enlaces de navegación para colecciones (first, last, prev, next).
6.8: Los enlaces deben ser consistentes en toda la API.
6.9: Se debe documentar todos los posibles enlaces en la especificación OpenAPI.
6.10: Los enlaces deben ser versionados junto con la API.