BT

Diffuser les Connaissances et l'Innovation dans le Développement Logiciel d'Entreprise

Contribuez

Sujets

Sélectionner votre région

Accueil InfoQ Actualités API Design-First En Utilisant Le Processus "Align-Define-Design-Refine"

API Design-First En Utilisant Le Processus "Align-Define-Design-Refine"

Le consultant James Higginbotham a écrit sur les avantages de l’approche API design-first en utilisant le processus « Align-Define-Design-Refine » (ou Aligner-Définir-Concevoir-Affiner en français). ADDR est un processus itératif destiné à guider ses utilisateurs dans la conception d'API. Concevoir une API de manière itérative tout en s'assurant que chacun soit activement impliqué est essentiel à l'agilité dans le développement.

Selon l'auteur, l’étape de conception d'API a lieu avant d'écrire un code de production. Cela consiste à traduire les exigences métier en une signature d'API qui fournit les résultats souhaités. L'objectif est d'obtenir suffisamment de détails au préalable pour éviter de futurs « breaking changes » tout en permettant aux clients de l'API de l'intégrer sans attendre l’implémentation complète. Les équipes peuvent « évoluer rapidement, de manière réfléchie et avec l'agilité nécessaire pour apporter des changements au début du process ».

James Higginbotham affirme qu'un processus de conception d'API "encourage l'efficacité tout au long du processus de livraison". Cet effet se produit parce que l’objectif principal est le contrat d’API pour les besoins des utilisateurs et des développeurs. La résilience aux changements d’implémentation interne au fil du temps est un avantage des process de conception d'API.

Le process ADDR de l'auteur divise le processus de conception d'API en cycles composés de sept étapes regroupées en quatre phases. Ces phases (traduites en français) sont Aligner, Définir, Concevoir et Affiner.

L'idée est d'aligner toutes les parties prenantes, puis de traduire leurs exigences dans des définitions de fonctions numériques, résultant en une conception technique d'API. Cette conception est ensuite affinée grâce aux commentaires, à la documentation, au prototypage et aux tests. Étant donné que l'ADDR est un processus itératif, les apprentissages de chaque itération sont pris en compte pour la suivante.

L'auteur souligne que la conception d'une API est une étape distincte et critique de la livraison de logiciels tout en reconnaissant que les équipes peuvent concevoir et livrer des API avec succès sans suivre un processus de conception formel.

D'autres auteurs ont exprimé leur point de vue sur la conception d'API. Ils tendent à converger vers les mêmes conclusions.

Joshua Bloch, professeur à l'Université Carnegie Mellon, a écrit un article sur l’ API design sur InfoQ. Là, il énumère de nombreux principes de conception d'API et convient que la collecte des exigences doit être la première étape du processus. Ces exigences doivent ensuite être structurées en cas d'utilisation et finalement codées en fonction de l'API avant sa mise en œuvre.

Le premier point de Ronnie Mitra, director of technology chez Publicis Sapient à Londres, dans son article API design process sur InfoQ est qu’ « une bonne conception d'API est produite par itérations ».

James Higginbotham détaille son processus ADDR dans son prochain livre, "Principles of Web API Design: Delivering Value with APIs and Microservices ».

Evaluer cet article

Pertinence
Style

Contenu Éducatif

BT