Implementar HATEOAS en les API REST

[jordidh]

Objectiu: permetre que els clients que consultin les API puguin anar descobrint quines altres URL poden fer servir a través dels HATEOAS.

Farem una incorporació de HATEOAS parcial, només en les consultes que retornin un llistat de resultats (ex: [get]/, però no en les de [get]{id}, [post], [put] i [delete] no).

Per exemple, els contenidors retornats per la API "/v1/containers" podrien tenir l'estructura:

[{
  "id": 0,
  "code": "new",
  "description": "new",
  "width": 0,
  "length": 0,
  "height": 0,
  "maxWeight": 0,
  "links": {
    "client": "/client?id=1234"
  }
},...]

Primer revisar si OPEN API ja ho incorpora d'alguna manera.