Comportement des mocks

Cette section décrit comment les mocks gèrent les différents éléments de la définition d'API disponibles dans API Designer.

Les mocks fournissent des réponses essentiellement statiques aux requêtes qui correspondent au contrat d'API. Ils répondent aux requêtes sans tenir compte de la sécurité définie sur l'API, de la charge utile de la requête ni des en-têtes de requête (à l'exception de l'en-tête Accept qui est utilisé pour la négociation de contenu).

Lorsqu'une requête est lancée, le mock crée une réponse basée soit sur ce que l'utilisateur a fourni (exemple, valeur par défaut, valeur d'énumération), soit sur une valeur d'exemple intégrée.

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

Réponses

Si votre opération n'a qu'une plage de réponses, le premier statut de la plage est renvoyé. Par exemple, une opération avec une plage de réponses 2XX renvoie une réponse 200.
Si votre opération a un code de réponse spécifique et des plages de réponse ou une réponse par défaut, le code défini est renvoyé. Par exemple, une opération avec une réponse 201 et une plage de réponses 3XX renvoie la réponse 201.
Si votre opération a plusieurs plages de réponse et aucun statut de réponse défini, le premier statut de la première plage est renvoyé. Par exemple, une opération avec une plage de réponses 4XX et une plage de réponses 5XX renvoie une réponse 400.
Si votre opération n'a qu'une réponse par défaut, la réponse renvoyée dépend de la méthode d'opération :
- Si la méthode utilisée est POST, une réponse 201 est renvoyée.
- Pour les autres méthodes, une réponse 204 est renvoyée si aucun corps de réponse n'est défini et une réponse 200 est renvoyé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 renvoyée.
Les réponses 1XX ne sont pas supportées par les mocks. Si une opération a la plage de réponses 1XX ou un code de réponse défini dans cette plage, une réponse 404 est renvoyée.

Combinations

All of : si un exemple est défini, il est renvoyé. Si aucun exemple n'est défini pour le type de données, les propriétés des types sont fusionnées et les exemples définis au niveau de la propriété sont utilisés ou des valeurs d'exemple sont générées. Si une propriété est définie deux fois dans des types différents, seule la dernière valeur est conservée. Les types primitifs sont ignorés ; seuls les objets sont renvoyés.
Any of ou One of : si un exemple est défini, il est renvoyé. 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 (Disponible uniquement dans la requête) : la propriété est exclue de l'exemple généré.
Available in response only (Disponible uniquement dans la réponse) : la propriété est incluse dans l'exemple généré.
Available in request and response (Disponible dans la requête et la réponse) : la propriété est incluse dans l'exemple généré.

Les exemples fournis au niveau du type de données priment sur les propriétés. Si une propriété définie comme Available in request only (Disponible uniquement dans la requête) est incluse dans l'exemple, elle est renvoyée dans la réponse. Si une propriété définie comme Available in response only (Disponible uniquement dans la réponse) ou Available in request and response (Disponible dans la requête et la réponse) est incluse dans l'exemple, elle est renvoyée dans la réponse.

Cette page vous a-t-elle aidé ?

Si vous rencontrez des problèmes sur cette page ou dans son contenu – une faute de frappe, une étape manquante ou une erreur technique – faites-le-nous savoir.

Laissez vos commentaires ici