Comportement des mocks - Cloud

Guide d'utilisation de Talend Cloud API Designer
Version
Cloud
Language
Français
Product
Talend Cloud
Module
Talend API Designer
Content
Création et développement > Création d'APIs
Last publication date
2024-03-13
Cette section décrit comment les mocks traitent les différents éléments de définition d'API disponibles dans Talend Cloud API Designer.

Les mocks fournissent principalement des réponses statiques aux requêtes correspondant au contrat de l'API. Ils répondent aux requêtes sans se soucier de la sécurité définie dans l'API, du payload de la requête ou des en-têtes de la requête (sauf l'en-tête Accept utilisé pour la négociation de contenu).

Lorsqu'une requête est effectuée, le mock crée une réponse basée sur ce qu'a fourni l'utilisateur ou l'utilisatrice (exemple, valeur par défaut, valeur d'énumération), ou utilisant une valeur d'exemple built-in.

Par exemple, si la requête retourne un objet, l'exemple de l'objet est utilisé si vous en avez fourni un. Sinon, les exemples de chacune des propriétés sont utilisés et un objet JSON est créé à partir de ceci. Cela fonctionne également pour les en-têtes de réponses.

Réponses

  • Si votre opération n'a qu'une famille de statut, le premier statut de cette plage est retourné. Par exemple, une opération avec une famille de statut 2XX retourne une réponse 200.
  • Si votre opération contient un code de statut et une famille de statut spécifiques ou une réponse par défaut, le code défini est retourné. Par exemple, une opération avec une réponse 201 et une famille de statut 3XX retourne la réponse 201.
  • Si votre opération contient plus d'une famille de réponse et pas de statut de réponse défini, le premier statut de la première famille est retournée. Par exemple, une opération avec une plage de réponse 4XX et 5XX retourne une réponse 400.
  • Si votre opération ne contient qu'une réponse par défaut, la réponse retournée dépend de la méthode d'opération :
    • Si la méthode utilisée est POST, alors la réponse 201 est retournée.
    • Pour d'autres méthodes, la réponse 204 est retournée si aucun corps de réponse n'est défini et une réponse 200 est retournée si un corps de réponse est défini.
  • Si votre opération n'a pas de réponse définie, une réponse 200 est retournée.
  • Les réponses 1XX ne sont pas supportées par les mocks. Si une opération a une plage de réponse 1XX ou un code de réponse défini dans cette plage, une réponse 404 est retournée.

Combinaisons

  • All of : si un exemple est défini, il est retourné. Si aucun exemple n'est défini pour le type de données, les propriétés de ces types sont fusionnées et les exemples définis au niveau de la propriété sont utilisés ou des valeurs d'exemples sont générées. Si une propriété est définie à deux reprises dans des types différents, seule la dernière valeur est préservée. Les types primitifs sont supprimés, seuls les objets sont retournés.
  • Any of ou One of : si un exemple est défini, il est retourné. Si aucun exemple n'est défini, une réponse est générée à partir du premier type de la liste.

Restrictions

  • Available in request only : la propriété est exclue de l'exemple généré.
  • Available in response only : la propriété est incluse dans l'exemple généré.
  • Available in request and response : la propriété est incluse dans l'exemple généré.

Les exemples fournis au niveau du type de données sont prioritaires sur les propriétés. Si une propriété définie comme Available in request only est incluse dans l'exemple, elle est retournée dans la réponse. Si une propriété définie comme Available in response only ou Available in request and response n'est pas incluse dans l'exemple, elle n'est pas retournée dans la réponse.