Parlez-nous du principe HATEOAS.

HATEOAS (Hypermedia en tant que Moteur de l’État de l’Application) est un principe clé des services RESTful. Il suppose que le client doit naviguer entre les états de l’application uniquement via des liens hypermédias fournis par le serveur dans les réponses. Cela rend l’API auto-découvrable et moins rigide, augmentant sa flexibilité et sa scalabilité.

Imaginons que nous recevons des informations sur une commande. Sans HATEOAS, la réponse pourrait ressembler à ceci :

{
  "order_id": 123,
  "status": "pending",
  "total": 100.50
}

Pour effectuer des actions sur cette commande (par exemple, payer ou annuler), le client doit connaître à l’avance les URLs et méthodes HTTP appropriées.

Avec HATEOAS, le serveur inclut dans la réponse des liens vers les actions disponibles :

{
  "order_id": 123,
  "status": "pending",
  "total": 100.50,
  "_links": {
    "self": { "href": "/api/orders/123" },
    "pay": { "href": "/api/orders/123/pay", "method": "POST" },
    "cancel": { "href": "/api/orders/123/cancel", "method": "PUT" }
  }
}

Désormais, le client, en recevant cette réponse, voit les actions disponibles (pay, cancel) et leurs URLs, sans avoir de connaissance préalable de la structure de l’API. Si le serveur décide de changer l’URL pour le paiement, le client recevra la nouvelle URL dans la réponse et pourra continuer sans modifier son code.

Avantages de HATEOAS :

• Flexibilité : L’API devient moins rigide par rapport aux URLs spécifiques. Les changements dans la structure ou les URLs ne nécessitent pas de re-codage du client.
• Auto-découverte : Le client peut explorer l’API simplement en suivant les liens dans les réponses.
• Évolution de l’API : Le serveur peut ajouter de nouvelles fonctionnalités (nouvelles liens) ou en supprimer, et le client pourra s’adapter.

Inconvénients de HATEOAS :

• Complexité de mise en œuvre : Le serveur doit générer et inclure des liens dans chaque réponse, ce qui peut être plus difficile à réaliser.
• Réponses plus volumineuses : Les réponses deviennent plus grandes en raison de l’inclusion de liens hypermédias.
• Complexité côté client : La logique du client doit être adaptée pour gérer et suivre ces liens hypermédias.

En QA / Automatisation QA, tester une API utilisant HATEOAS nécessite une approche particulière. Au lieu de coder en dur les URLs dans les tests, il faut extraire ces liens des réponses et les utiliser pour les requêtes suivantes. Cela rend les tests plus résilients face aux changements de l’API. Par exemple, en Java avec RestAssured :

// Obtenir les informations de la commande
Response orderResponse = given()
    .when()
    .get("/api/orders/123")
    .then()
    .statusCode(200)
    .extract().response();

// Extraire l’URL de paiement à partir des liens hypermédias
String payUrl = orderResponse.jsonPath().getString("_links.pay.href");
String payMethod = orderResponse.jsonPath().getString("_links.pay.method");

// Effectuer la requête de paiement en utilisant les données extraites
given()
    .when()
    .request(payMethod, payUrl) // Au lieu d’une URL fixe
    .then()
    .statusCode(200);

Ainsi, HATEOAS est un principe important pour créer des API véritablement RESTful, augmentant la flexibilité et la facilité d’utilisation. Pour les testeurs, cela implique d’adapter les stratégies de test pour travailler avec des liens hypermédias dynamiques.