Mocks d'API

Prototypage d'API

Le premier cas d'usage des mocks d'API est le prototypage d'API. L'idée, c'est qu'une fois que vous avez terminé une itération de votre conception d'API, vous souhaitez obtenir des retours d'information de différentes parties prenantes au projet d'API : membres de l'équipe, développeurs qui consommeront l'API, product owners, etc.

Si les parties prenantes peuvent réellement interagir avec la conception d'API, vous êtes plus susceptible d'obtenir de meilleurs retours d'information, également plus rapidement, car l'expérience d'examen de l'API est plus immersive et réaliste.

Implémentation parallèle du frontend et du backend

Dans de nombreux projets, une fois la phase de conception de l'API terminée, il y aura à la fois du code backend à écrire pour implémenter l'API et du code frontend qui consommera l'API.

Une fois le contrat d'API établi, il n'existe aucune raison réelle pour que les développeurs frontend attendent que les développeurs backend aient terminé avant de commencer. Procéder de manière aussi linéaire augmentera le temps de mise sur le marché et ralentira les cycles de retours d'information entre les équipes backend et frontend lors du développement.

Disposer d'un mock d'API à jour correspondant à la dernière conception du contrat d'API permet aux équipes frontend et backend de travailler en parallèle.

Négociation de contenu

Le seul dynamisme fourni par les mocks est la négociation de contenu. Si vous avez plusieurs corps définis dans l'API et que vous lancez une requête avec un type de média compatible dans votre en-tête Accept, le mock utilise ce corps pour créer la réponse.

Tester un mock

Vous pouvez tester votre mock à l'aide de n'importe quel client API tel que API Tester, Postman ou cURL, en envoyant des requêtes à l'URL du endpoint du mock affichée dans API Designer.