Usage

Endpoints

• Il est possible de désactiver une route temporairement

Routes désactivées:

• Il est possible de dupliquer une route existante vers un autre environnement, cela peut être utile de dupliquer une route de l'environnement créé avec l'import Swagger vers un autre environnement

attention

Attention, si une route avec un path dynamique peut matcher avec une autre route statique, il faut s'assurer que la route statique soit placée avant la route dynamique. La première route qui matche l'url sera renvoyée en premier.

Example, il faut bien placer la route avec :id en second :

Réponses

• Mockoon utilise du templating (handlebars) pour générer ces réponses (docs)
• Des helpers sont disponibles pour aider à générer des données (docs - helper)
• Il expose l'api fakerjs pour générer à la volée de fausse données

Exemples :

// retourne une liste de 3 éléments avec des valeurs générés
[
  {{#repeat 3}}
  {
    // generated data
    "id": {{faker 'number.int' max=99999}},
    "intitule": "{{faker 'company.name'}}",
    "isEtablissement": {{faker 'datatype.boolean'}},
    // static data
    "isValid": true
  }
  {{/repeat}}
]

info

Pour formatter les dates, on doit appeler le helper dateFormat en lui passant l'objet retourné par faker -qui n'est pas une string- (e.g: faker 'date.past') et eventuellement un format. Cette méthode de formattage se base sur la librairire js date-fns.

{
    "startDate": "{{dateFormat (faker 'date.past') 'YYYY-MM-dd'}}",
    "endDate": "{{dateFormat (faker 'date.soon') 'YYYY-MM-dd'}}"
}

• Il est possible d'ajouter plusieurs réponses différentes, grâce aux règles :

Exemple, cette réponse sera envoyé si le queryParam searchTerm est différent de "toto" (ici la négation a été activée)

• Il est possible de configurer plusieurs modes de réponses :

1. La réponse par défaut est celle avec le flag actif, elle sera retourné si aucune des réponses ne correspond aux règles définies

2. Random response mode : Une des réponses sera retourné aléatoirement sans tenir en compte des règles

3. Sequential mode : Les réponses seront retournées séquentiellement sans tenir en compte des règles

4. Disabled rules : Seul la réponse par défaut sera retournée

5. Fallback mode : Retournera la réponse d'une route suivante qui matche ou du serveur proxy sans tenir compte des règles ni de la réponse par défaut

Latence

• Il est possible de rajouter de la latence globalement et/ou sur chaque requête afin de simuler une requête réseau plus lente.
  Il est conseillé de rajouter une petite latence afin de visualiser les loaders du front-end.

Paramètre global à l'environnement :

Paramètre par route :

attention

• Les endpoints back-end retournant des Pageable qui retournent le numéro de page et l'offset d'une collection devraient retourner ces informations de façon cohérente pour éviter que la pagination front soit impactée. Le front se sert du retour du backend pour la pagination, si le retour est mocké avec faker et que c'est incohérent avec le JDD, cela peut poser problème.
  Par défaut lors de l'import swagger, les champs d'information de la pagination sont mockés avec des entiers aléatoires.