Aller au contenu

Contrat d'API généré à partir de la base

Généré le contrat d'API à partir de la base de données — OpenAPI, client TypeScript typé de 44 076 lignes, 61 gestionnaires de simulation et limites appliquées par l'interface — avec un contrôle à chaque étape qui échoue en cas de divergence.

44,076 lignes de client typé générées depuis la base

Situation. L’interface et le serveur avancent à leur propre rythme, et leurs hypothèses sur le contenu d’une requête peuvent diverger sans que personne le remarque. La découverte se fait généralement par une erreur 422 dans le navigateur — après la livraison de l’incompatibilité, au moment le plus coûteux pour l’apprendre. Écrire les deux côtés à la main à partir du même document ne résout pas le problème ; cela déplace simplement la divergence vers la personne qui a oublié de relire ce document.

Tâche. Les deux côtés devaient être générés à partir d’une source unique plutôt que faire l’objet d’un accord entre deux sources, chaque étape de génération étant vérifiée au lieu d’être tenue pour fiable.

Action. La chaîne part de la base de données et progresse vers l’extérieur. Le schéma et ses fonctions définissent les structures ; les types Go définissent l’API ; Huma en produit la description OpenAPI ; un client TypeScript typé — 44 076 lignes — est généré à partir de cette description ; 61 gestionnaires simulés sont générés à ses côtés pour que les tests de l’interface s’exécutent contre le véritable contrat plutôt qu’un jeu de données de test écrit à la main ; et les limites imposées par l’UI dans un formulaire viennent du même endroit au lieu d’être ressaisies dans un validateur. Chaque relais possède un garde‑fou. Un contrôle de contrat en CI compare ce qu’envoie l’interface à ce qu’attend l’API et fait échouer la compilation en cas de divergence, avec en dessous une sonde du schéma qui vérifie les structures réelles plutôt que leur description. Le contrôle couvre délibérément les endroits où les divergences se cachent volontiers : les champs facultatifs du corps, où « absent » et « null » se confondent, et les énumérations des paramètres de requête, où les deux côtés peuvent diverger discrètement sur les valeurs autorisées.

Résultat. Un champ ne peut pas changer d’un seul côté — la compilation échoue au premier relais qui détecte l’écart, quelques minutes après la modification. Cela a supprimé une catégorie de défauts récurrents et réellement agaçants, invisibles en revue de code et ne se manifestant qu’à l’exécution. Le coût est une étape de génération au milieu de tout : régénérer est une corvée, et la fiabilité de la chaîne dépend de son maillon le moins surveillé, raison pour laquelle chaque relais a reçu un garde‑fou.

  • Pièce de puzzle détachée à côté d’un emplacement vide
    Photo : 422737 / Pixabay
  • Pièces de puzzle multicolores
    Photo : rkit / Pixabay

Mettez cette expérience au service de votre projet

Prenez « Contrat d'API généré à partir de la base » comme point de départ pour un défi similaire dans votre organisation. Les prestations mobilisées pour cette réalisation sont disponibles pour votre projet. La partie invisible pour les utilisateurs : où résident les données, quelles règles s'appliquent et comment les autres systèmes peuvent y accéder.

Découvrir nos prestations Contactez-nous

Examinez ce qui a conduit au résultat

Découvrez la situation, les décisions et le résultat de cet exemple. Nous pouvons discuter des éléments transposables à vos contraintes et de ceux qui nécessitent une autre démarche. Contrat d'API généré à partir de la base — 44,076 lignes de client typé générées depuis la base

Découvrir nos prestations Contactez-nous

Un élément d'un parcours plus long — entièrement présenté sur ce site.

Chaque entrée suit la même structure : la situation, la tâche, ce que nous avons fait et ce qui a changé.

Voir l'ensemble du parcours

Définissez l'amélioration nécessaire

Présentez le processus de travail, les interfaces existantes et les utilisateurs qui ont besoin du changement. Nous pouvons définir une livraison testable et une transmission permettant à votre équipe d'assurer la maintenance des éléments livrés.

Consulter les tarifs Contactez-nous

Le frontend et le backend s'éloignent l'un de l'autre ?

Interrogez-nous sur les décisions qui sous-tendent « Contrat d'API généré à partir de la base ». Vous parlerez aux personnes capables d'expliquer le travail et d'évaluer votre propre projet.

Découvrir nos prestations
welcome@engineer.company +45 50 10 61 84 Copenhague, Danemark
Code QR pour Généré le contrat d'API à partir de la base de données — OpenAPI, client TypeScript typé de 44 076 lignes, 61 gestionnaires de simulation et limites appliquées par l'interface — avec un contrôle à chaque étape qui échoue en cas de divergence.
Emportez cette page avec voushttps://engineer.company/fr/portfolio/generated-the-api-contract-from-the-database-out/