Générer une réponse avec les mocks d'API - Cloud

Guide d'utilisation de Talend Cloud API Designer

author
Talend Documentation Team
EnrichVersion
Cloud
EnrichProdName
Talend Cloud
task
Création et développement > Création d'APIs
EnrichPlatform
Talend API Designer
Une fois qu'un mock d'API est activé, il est immédiatement disponible.

Les mocks d'API répondent de la manière la plus réaliste possible aux appels reçus. Lors de la génération d'un corps de réponse, un mock donne la priorité aux données fournies par l'utilisateur en recherchant un champ d'exemple, puis une valeur par défaut, puis un champ d'énumération. Si un exemple est trouvé, il est utilisé, sinon un exemple JSON sera généré en se basant sur le type de données retourné par l'opération appelée.

Voici un exemple, avec la définition du type de données Company ci-dessous. Il ne contient pas d'exemple fourni par l'utilisateur.

Lorsque le mock est activé, un appel GET effectué vers la ressource /company/{companyId} retourne une réponse JSON automatiquement générée, basée sur la structure du type de données, comme affiché ci-dessous, à l'aide de Talend Cloud API Tester.

Le mock a effectué différentes opérations, notamment la génération de valeurs pour des en-têtes de réponse personnalisés (par exemple x-my-custom-header), l'identification de tableaux et la création d'exemples appropriés (comme la propriété tags), ainsi que l'identification de structures imbriquées et la génération de valeurs pour celles-ci (par exemple la propriété address).

Les mocks de Talend Cloud API Designer supportent la négociation de contenu, vous pouvez donc utiliser l'en-tête de requête Accept afin de sélectionner le corps à retourner parmi les différentes options (chacune avec potentiellement son propre exemple) et donc changer les exemples retournées par le mock.