DEV Community

Cover image for Comment simuler une API sur Apidog sans écrire une ligne de code
Antoine Laurent
Antoine Laurent

Posted on • Originally published at apidog.com

Comment simuler une API sur Apidog sans écrire une ligne de code

Votre équipe frontend est bloquée : les endpoints GET /users et GET /orders ne sont pas encore disponibles, mais l’interface doit afficher des listes, gérer la pagination et tester les états vides. Maintenir des fichiers JSON statiques à la main fonctionne rarement longtemps : dès qu’un champ évolue, les mocks se désynchronisent du contrat d’API.

Essayez Apidog dès aujourd'hui

Si votre spécification API existe déjà, Apidog peut générer un mock directement depuis le schéma de réponse. Cette fonctionnalité, Smart Mock, utilise les noms et les types des propriétés pour produire des données plausibles : name génère un nom, email une adresse e-mail, etc. Pour les bases, consultez ce qu'est le mocking d'API et comment il fonctionne, ainsi que la documentation de JSON Schema.

Ce que Smart Mock génère

Le moteur de mock d’Apidog peut renvoyer plusieurs types de réponses :

  • des données générées depuis le schéma : Smart Mock ;
  • un exemple de réponse défini dans l’API ;
  • une réponse personnalisée ;
  • des réponses conditionnelles selon les paramètres de requête ;
  • des réponses construites à partir de scripts de mock.

Interface Smart Mock d'Apidog

Smart Mock est l’option sans configuration : définissez un schéma de réponse et Apidog remplit les champs automatiquement. Aucun exemple JSON ni règle personnalisée n’est requis pour démarrer.

L’intérêt principal est que le mock et le contrat utilisent la même source. Quand vous modifiez le schéma, la réponse mockée évolue avec lui.

Prérequis

Smart Mock nécessite une réponse définie sur l’endpoint.

Si vous concevez l’API dans Apidog, ajoutez un schéma sous la réponse de l’endpoint. Si vous importez une spécification OpenAPI, les schémas de réponse sont généralement déjà inclus.

Pour utiliser Local Mock, installez le client de bureau. Il n’est pas disponible dans Apidog Web. Vous pouvez télécharger Apidog pour suivre ce guide.

Simuler GET /users et GET /orders

Prenons une petite API e-commerce avec deux endpoints.

1. Définir les schémas de réponse

Créez GET /users avec une réponse structurée comme suit :

{
  "id": 1024,
  "name": "Amara Osei",
  "email": "amara.osei@example.com",
  "phone": "+1-415-555-0148",
  "createdAt": "2026-03-11T09:24:00Z",
  "isActive": true
}
Enter fullscreen mode Exit fullscreen mode

Créez ensuite GET /orders :

[
  {
    "orderId": "ORD-58210",
    "userId": 1024,
    "total": 84.5,
    "currency": "USD",
    "status": "shipped",
    "createdAt": "2026-05-02T14:03:00Z"
  }
]
Enter fullscreen mode Exit fullscreen mode

Vérifiez que chaque propriété dispose d’un type dans le schéma. Smart Mock s’appuie sur les types et les noms de champs pour générer les valeurs.

2. Copier l’URL de mock

Chaque endpoint reçoit automatiquement une URL de mock.

  • En mode DESIGN, ouvrez l’onglet API de l’endpoint.
  • En mode DEBUG, ouvrez l’onglet Mock.

Cliquez sur Cliquer pour copier. Cette action copie seulement l’URL : vous devrez préciser vous-même la méthode HTTP et le corps de requête si nécessaire.

En mode chemin, une URL de Local Mock ressemble à ceci :

http://127.0.0.1:4523/m1/{projectID}-{versionNo}-{serverNo}/users
Enter fullscreen mode Exit fullscreen mode

Local Mock démarre automatiquement lorsque le client Apidog est ouvert.

Le mode ID cible directement un endpoint avec son identifiant :

http://127.0.0.1:4523/m2/{projectID}-{versionNo}-{serverNo}/{endpointId}
Enter fullscreen mode Exit fullscreen mode

3. Appeler le mock

Appelez l’endpoint utilisateur avec curl :

curl http://127.0.0.1:4523/m1/1234567-0-0/users
Enter fullscreen mode Exit fullscreen mode

Smart Mock peut produire une réponse de ce type :

{
  "id": 3187,
  "name": "Diego Marchetti",
  "email": "diego.marchetti@example.net",
  "phone": "+1-628-555-0113",
  "createdAt": "2026-01-27T18:41:22Z",
  "isActive": true
}
Enter fullscreen mode Exit fullscreen mode

Les valeurs ne sont pas de simples chaînes aléatoires : name est interprété comme un nom, email comme une adresse e-mail et createdAt comme un horodatage. À chaque nouvelle requête, les valeurs dynamiques peuvent être régénérées.

Appelez les commandes de la même façon :

curl http://127.0.0.1:4523/m1/1234567-0-0/orders
Enter fullscreen mode Exit fullscreen mode

Vous obtenez un tableau de commandes utilisable immédiatement dans une vue de liste, une table ou un composant de pagination.

Comment Smart Mock choisit les valeurs

Pour chaque propriété, Smart Mock applique une priorité en trois niveaux.

  1. Champ de Mock

    Une valeur ou expression personnalisée définie sur la propriété est prioritaire. Utilisez :

    • une valeur fixe pour une réponse toujours identique ;
    • une instruction Faker pour générer plusieurs valeurs contrôlées.

  2. Correspondance des noms de propriété

    Sans champ de Mock, Apidog applique des règles intégrées basées sur les noms de champs. C’est ce qui permet à email, phone ou createdAt de générer des formats cohérents.

  3. JSON Schema

    Si aucune règle de nom ne correspond, Smart Mock génère une valeur selon le type et les contraintes du schéma.

Priorité de génération Smart Mock

Les contraintes JSON Schema sont respectées, notamment :

  • enum ;
  • minimum et maximum ;
  • minLength et maxLength ;
  • pattern ;
  • minItems et les contraintes de tableaux.

Par exemple, un champ status défini avec une énumération ne renverra que les valeurs autorisées :

{
  "type": "string",
  "enum": ["pending", "shipped", "delivered"]
}
Enter fullscreen mode Exit fullscreen mode

Vous pouvez également choisir une locale de mock pour adapter les noms, adresses et formats de données à un pays ou une région.

Corriger une valeur générée incorrectement

Smart Mock repose sur une inférence. Un champ comme sku peut ne correspondre à aucune règle intégrée, et total peut nécessiter une plage plus précise.

Appliquez ces corrections dans cet ordre.

1. Renforcer le schéma

Ajoutez des contraintes avant de personnaliser le mock.

Exemple pour un montant :

{
  "type": "number",
  "minimum": 1,
  "maximum": 1000
}
Enter fullscreen mode Exit fullscreen mode

Exemple pour un SKU :

{
  "type": "string",
  "pattern": "^[A-Z]{3}-[0-9]{5}$"
}
Enter fullscreen mode Exit fullscreen mode

2. Définir un champ de Mock

Utilisez une valeur fixe pour un champ stable :

USD
Enter fullscreen mode Exit fullscreen mode

C’est utile pour currency si toutes les réponses doivent retourner USD.

Utilisez une instruction Faker lorsque vous voulez varier les données. La couche Faker d’Apidog suit les mêmes principes que Mock.js. Pour la syntaxe, consultez le guide sur l'utilisation de Faker dans Apidog.

3. Ajouter une règle de correspondance de nom

Si sku apparaît dans plusieurs endpoints, créez une règle globale :

  1. Ouvrez Paramètres.
  2. Allez dans Paramètres généraux.
  3. Ouvrez Paramètres de fonctionnalité.
  4. Sélectionnez Paramètres de Mock.
  5. Cliquez sur Nouveau.
  6. Définissez la condition de correspondance et l’expression de mock.

Tous les champs sku correspondants pourront ensuite utiliser cette règle dans le projet.

Comprendre la priorité des réponses mockées

Lorsqu’un endpoint possède à la fois des attentes de mock, un exemple de réponse et Smart Mock, Apidog utilise le réglage Default mock method dans les paramètres du projet.

Deux comportements sont disponibles :

  • Smart Mock en premier : Mock Expectation → Smart Mock
  • Exemple de réponse en premier : Mock Expectation → Response Example → Smart Mock

Les attentes de mock restent toujours prioritaires si leurs conditions correspondent.

Par exemple, vous pouvez configurer une attente qui retourne 404 lorsque userId=9999. Cette réponse conditionnelle sera retournée avant Smart Mock ou un exemple de réponse.

Pour aller plus loin, consultez le mocking de réponses API conditionnelles dans Apidog.

En pratique :

  1. une Mock Expectation correspondante l’emporte toujours ;
  2. vient ensuite Smart Mock ou l’exemple de réponse, selon votre réglage ;
  3. Smart Mock sert de repli lorsque rien d’autre ne correspond.

Local Mock, Cloud Mock et Runner Mock

Le type de mock décrit la façon dont la réponse est générée. Le mode d’hébergement détermine où elle est accessible.

  • Local Mock

    S’exécute sur votre machine via le client Apidog, sur 127.0.0.1:4523. Il fonctionne uniquement lorsque le client est ouvert.

  • Cloud Mock

    Est hébergé par Apidog et accessible en continu. Il est désactivé par défaut : activez-le dans la gestion des environnements lorsque des collègues ou une prévisualisation déployée doivent appeler le mock. Les URL utilisent https://mock.apidog.com.

  • Runner Mock

    Est auto-hébergé sur l’infrastructure de votre équipe, pour les environnements internes ou les réseaux privés.

Choisissez :

  • Local Mock pour le développement frontend local ;
  • Cloud Mock pour partager rapidement une API mockée ;
  • Runner Mock lorsque les mocks doivent rester dans votre infrastructure.

Pour comparer les solutions disponibles, consultez cette comparaison des outils de mocking API en ligne. Pour configurer le mode hébergé, suivez le guide Apidog Cloud Mock.

Pièges de routage à éviter

Quelques détails peuvent empêcher un mock de répondre correctement.

Le chemin doit commencer par /

Utilisez :

/orders
Enter fullscreen mode Exit fullscreen mode

Un chemin sans slash initial ne passe pas correctement par l’environnement de mock en mode chemin. Une URL complète ne déclenche pas non plus l’environnement de mock de la même façon.

Deux endpoints peuvent partager le même chemin

Si deux API utilisent la même méthode et le même chemin, ajoutez l’identifiant de l’API :

?apidogApiId={endpointId}
Enter fullscreen mode Exit fullscreen mode

Cela permet de cibler l’endpoint attendu.

Les données changent à chaque requête

Les valeurs dynamiques sont régénérées à l’actualisation. Si vous obtenez systématiquement la même réponse, vérifiez que votre client HTTP ou votre navigateur ne sert pas une réponse mise en cache.

Automatiser le contrat avec Apidog CLI

Le serveur de mock est géré par Local Mock, Cloud Mock ou Runner Mock. L’interface de ligne de commande Apidog (CLI) ne démarre pas un serveur de mock depuis le terminal.

En revanche, elle aide à maintenir le schéma qui alimente vos mocks. Puisque Smart Mock dépend du contrat d’API, toute mise à jour correcte des endpoints et de leurs schémas maintient les réponses mockées cohérentes.

Une fois le frontend débloqué, utilisez les scénarios de test du même projet en CI pour vérifier le backend réel :

apidog run -t <scenario_id> -e <env_id> -r html,cli
Enter fullscreen mode Exit fullscreen mode

Installation :

npm install -g apidog-cli
Enter fullscreen mode Exit fullscreen mode

Authentification :

apidog login --with-token <your-token>
Enter fullscreen mode Exit fullscreen mode

Pour l’intégration continue, consultez l'exécution d'Apidog dans un pipeline CI/CD.

FAQ

Dois-je écrire du code pour utiliser Smart Mock ?

Non. Un schéma de réponse suffit. Utilisez un champ de Mock, une instruction Faker ou un script uniquement si vous devez contrôler un champ particulier. Consultez aussi l'aperçu de l'API de mock.

Pourquoi mon URL de mock ne renvoie-t-elle rien ?

Vérifiez ces points :

  • l’endpoint possède une réponse avec un schéma ;
  • le chemin commence par / ;
  • le client Apidog est ouvert si vous utilisez Local Mock.

Comment retourner une valeur fixe ?

Définissez le champ de Mock de la propriété avec une valeur fixe. Ce réglage est prioritaire sur la correspondance de nom et les valeurs par défaut du schéma.

Mes collègues peuvent-ils appeler mon Local Mock ?

Seulement via votre réseau local, et uniquement lorsque le client Apidog est ouvert. Pour un accès durable, activez Cloud Mock.

Que se passe-t-il si j’ai un exemple de réponse et Smart Mock ?

Le résultat dépend du paramètre Default mock method :

  • avec Smart Mock en premier, Smart Mock est utilisé ;
  • avec Exemple de réponse en premier, l’exemple est utilisé avant Smart Mock ;
  • une Mock Expectation correspondante reste toujours prioritaire.

En résumé

Smart Mock transforme un schéma d’API en endpoint mocké sans code ni configuration manuelle. Définissez votre réponse, copiez l’URL de mock, puis appelez-la depuis votre frontend.

Lorsque les données générées ne correspondent pas à vos besoins :

  1. renforcez le schéma ;
  2. définissez un champ de Mock ;
  3. ajoutez une règle de correspondance globale si nécessaire.

Les attentes de mock restent prioritaires, tandis que Smart Mock garantit un repli utile pour les endpoints sans réponse personnalisée.

Top comments (0)