Pourquoi l’expérience développeur des API est importante

Rajesh BavananthamDirecteur de la gestion des produits | NGINX

Ceci est le deuxième article d’une série en deux parties consacrée à API Connectivity Manager :

• 5 façons de lutter contre la prolifération des API (et pourquoi vous devriez vous en préoccuper)
• Pourquoi l’expérience des développeurs d’API est importante – cet article

Les API sont au cœur des entreprises modernes. Si elles ont toujours joué un rôle important dans le développement logiciel, la demande croissante en matière d’intégration des données conduit à leur adoption plus large dans tous les secteurs d’activité. Mais les API ne se contentent pas de connecter des données et des applications : elles sont essentielles pour collaborer avec des partenaires commerciaux externes, fournir des services aux clients et générer des revenus en tant que produits à part entière.

Les développeurs jouent un rôle essentiel au cœur de l’économie des API. Chargés de créer, d’intégrer et de maintenir les API, ils en sont à la fois les créateurs et les utilisateurs techniques. Leur expérience, communément appelée « expérience développeur des API », est l’un des facteurs les plus importants pour déterminer la réussite globale d’une API. Cet article présente les concepts clés de l’expérience développeur des API et les éléments que les responsables informatiques doivent prendre en compte lors de la conception de l’expérience API.

1. Qu’est-ce que l’expérience développeur des API ?
2. Pourquoi l’expérience développeur des API est-elle importante ?
3. Comment créer d’excellentes expériences pour les développeurs d’API ?

Qu’est-ce que l’expérience développeur des API ?

L’expérience développeur des API désigne l’ensemble des perceptions et des émotions qu’un développeur éprouve lorsqu’il interagit avec une API. Elle englobe l’infrastructure, les outils, les processus, l’assistance et les autres points de contact qui contribuent à offrir une expérience agréable et fluide aux développeurs intégrant des API à leurs applications. L’expérience développeur des API est une sous-discipline de l’expérience développeur au sens large.

Pourquoi l’expérience développeur des API est-elle importante ?

Si l’attention constante portée à l’expérience utilisateur a été le moteur de la première génération d’innovations technologiques, la prochaine génération d’entreprises prospères s’imposera en mettant l’accent sur l’expérience développeur.

À mesure que l’économie des API poursuit son essor, les développeurs exercent une influence croissante sur le choix des API adoptées. Lorsqu’une API est difficile à trouver, insuffisamment documentée ou mal maintenue, ils l’abandonnent au profit d’une solution plus simple et plus rapide. Cela vaut aussi bien pour les programmes d’API internes que pour les API externes destinées aux partenaires et aux clients.

Dans le cas des API externes, l’abandon de votre API par les développeurs entraîne des conséquences commerciales concrètes. Non seulement vous perdez les revenus générés par vos clients directs, mais vous perdez également l’accès à l’écosystème plus large de produits et de solutions qu’ils utilisent. Même les programmes d’API internes pâtissent d’une mauvaise expérience développeur, qui se traduit notamment par un allongement des délais de mise sur le marché, une baisse de la productivité des développeurs et une augmentation du travail à refaire, ce qui peut compromettre la réussite de votre entreprise.

Pour réussir dans un monde centré sur les développeurs, vous devez adopter une stratégie d’API qui leur fournit les outils et les ressources adaptés à chaque étape du cycle de vie des API. Pour y parvenir, la meilleure approche consiste à leur offrir une expérience API cohérente et soigneusement pensée de bout en bout, couvrant trois types d’utilisation des API :

• Déployer et gérer des API
• Découverte et test des API
• Surveillance et sécurisation des API

Comment créer d’excellentes expériences pour les développeurs d’API ?

Créer une expérience positive implique de comprendre comment les développeurs utilisent votre API, ce dont ils ont besoin pour accomplir leurs tâches et, en définitive, ce qu’ils ressentent lorsqu’ils utilisent votre API. Une fois que vous avez défini les profils types qui interagiront avec vos API, vous pouvez commencer à concevoir l’expérience globale liée à vos API.

Quatre principes sont à prendre en compte lors de la conception de l’expérience développeur d’une API :

1. Identifier les utilisateurs – Qui interagit avec l’API ?
2. Définir les fonctionnalités – Que fait l’API ?
3. Optimiser la facilité d’utilisation – L’API est-elle facile à utiliser ?
4. Améliorer l’expérience – Quel ressenti procure l’utilisation de l’API ?

Examinons chaque principe ainsi que les éléments à fournir pour offrir aux développeurs une expérience optimale avec l’API.

Étape 1 : identifier les utilisateurs

Tout comme vous concevez des produits pour répondre à des problématiques spécifiques de vos clients, vous devez concevoir l’expérience liée aux API dans l’ensemble de votre infrastructure et de vos produits afin de répondre aux préoccupations des développeurs. Les développeurs ne sont pas seulement les utilisateurs finaux : ils assurent également la création et la maintenance de l’infrastructure globale.

Lors de la conception de l’expérience développeur d’une API, trois profils principaux sont à prendre en compte :

• Consommateurs d’API – Découvrent, mettent en œuvre et assurent la maintenance des intégrations d’API pour leurs applications
• Propriétaires d’API – Planifier, créer, documenter, tester, déployer et gérer les API de leurs services
• Responsables de l’infrastructure – Définissent des politiques globales et surveillent les API afin de garantir leur sécurité et leur conformité

Vous devrez peut-être prendre en compte d’autres utilisateurs et parties prenantes. Par exemple, la catégorie des consommateurs d’API peut inclure des sous-catégories telles que les développeurs internes, les partenaires et les clients, chacune ayant des profils et des exigences différents.

Étape 2 : définir les fonctionnalités

La fonctionnalité est le fondement de toute API réussie. Une bonne API permet aux développeurs d’intégrer des données ou des services utiles, d’accomplir leurs tâches plus rapidement et de réduire le temps global consacré au développement de nouvelles fonctionnalités. Les principaux éléments à prendre en compte sont les suivants :

• Quelle valeur l’API apporte-t-elle grâce à l’intégration de données ou de services ?
• Dans quelle mesure l’API résout-elle le problème en réduisant le nombre d’appels et en structurant les données ?
• Dans quelle mesure l’API est-elle fiable en matière de disponibilité, de fiabilité et d’évolutivité ?

Les fonctionnalités d’une API sont étroitement liées à l’approche de développement « API-first ». Contrairement à l’approche « code-first », l’approche « API-first » consiste à rédiger la spécification de l’API avant de commencer à développer le code, en mettant l’accent sur la structure des requêtes adressées à l’API et sur les données renvoyées. Cette priorité garantit que l’API fournit systématiquement la valeur et les fonctionnalités dont les développeurs ont besoin.

Étape 3 : optimisez la facilité d’utilisation

Le troisième principe, la facilité d’utilisation, porte sur la manière dont les développeurs utilisent vos API, plutôt que sur ce qu’ils peuvent faire avec elles. Il englobe les ressources qui accompagnent votre API et facilitent sa découverte, son apprentissage, ses tests et la prise en main. Sans un écosystème adapté composé d’infrastructures, d’outils et de documentation, les développeurs auront du mal à utiliser vos API. Parmi les points importants à prendre en compte figurent :

• Inscription simplifiée avec authentification unique (SSO) intégrée et gestion aisée des clés d’API
• Documentation claire et complète avec des références à jour et des exemples de code
• Mise en place rapide permettant idéalement de créer une requête API de base en moins de cinq minutes

Dans le rapport 2022 de Postman sur l’état des API, les personnes interrogées ont indiqué que les principaux obstacles à l’utilisation des API sont les suivants :

• Manque de documentation (55 %)
• Difficultés à découvrir les API (38 %)
• Manque de connaissances fondamentales sur les API (30 %)

Vous pouvez surmonter ces difficultés en vous appuyant sur des portails développeurs centralisés proposant une documentation complète, des exemples de code et des outils permettant de tester les API.

Étape 4 : Améliorer l’expérience

L’expérience développeur d’une API est la somme des interactions entre le consommateur et le propriétaire de l’API. Elle repose avant tout sur les fonctionnalités et la facilité d’utilisation de l’API, mais d’autres interactions contribuent également au plaisir global de travailler avec celle-ci. Il peut notamment s’agir des éléments suivants :

• Communauté active présente sur des plateformes telles que Stack Overflow, Slack, Discord, Twitter, etc.
• Assistance facilement accessible avec des réponses rapides de la part des équipes de développement
• Expérience fluide lors des interactions avec l’API, la documentation et la communauté

Les développeurs qui apprécient de travailler avec vos API sont plus susceptibles de les recommander à leurs collègues, de développer de nouvelles fonctionnalités autour de celles-ci et de les intégrer à leurs applications.

L’expérience des développeurs d’API est essentielle

La clé d’une excellente expérience développeur avec une API réside à la fois dans votre API et dans l’écosystème d’outils, de processus, de documentation et d’assistance qui l’entoure. Lorsque tous les éléments de cet écosystème fonctionnent ensemble de manière fluide, ils réduisent les obstacles et la complexité, permettant ainsi aux développeurs de se concentrer sur la création d’applications.

Les étapes présentées ci-dessus s’inscrivent dans un processus continu de conception, de mise en œuvre, de test et d’évaluation de l’expérience des développeurs avec l’API. En vous concentrant sur chacune des principales étapes – identifier les utilisateurs, définir les fonctionnalités, optimiser la facilité d’utilisation et améliorer l’expérience – vous pouvez créer des API agréables, voire amusantes, à utiliser.

Comment NGINX améliore-t-il l’expérience des développeurs d’API ?

API Connectivity Manager, qui fait partie de F5 NGINX Management Suite, a été conçu en plaçant l’expérience des développeurs d’API au cœur de sa conception. Avec API Connectivity Manager, les équipes d’infrastructure peuvent déployer des passerelles d’API hautes performances et des portails pour développeurs. Les développeurs peuvent quant à eux publier et gérer rapidement des API et leur documentation, ou encore découvrir et intégrer des API dans des applications.

Les avantages d’API Connectivity Manager sont notamment les suivants :

• Intégration rapide – Intégrez votre fournisseur d’identité préféré afin de simplifier l’autorisation et l’authentification sur le portail des développeurs
• Documentation simplifiée – Utilisez la spécification OpenAPI pour générer automatiquement la documentation du portail des développeurs lorsque les propriétaires d’API publient leurs API sur la passerelle d’API
• Apprentissage interactif – Permettez aux développeurs de découvrir, de tester et d’apprendre à utiliser vos API grâce à un explorateur d’API intégré au portail des développeurs
• Automatisation des workflows – Intégrez la publication et la gestion des API à vos pipelines CI/CD à l’aide d’une API REST entièrement déclarative

Commencer

Commencez un essai gratuit de 30 jours de NGINX Management Suite, qui comprend API Connectivity Manager et Instance Manager.

Ressources connexes

• Blog : Connectez, faites évoluer et sécurisez les applications et les API avec F5 NGINX Management Suite
• Blog : 5 façons de lutter contre la prolifération des API (et pourquoi cela devrait vous préoccuper)
• Présentation de la solution : NGINX Management Suite API Connectivity Manager

À propos de l’auteur

Rajesh BavananthamDirecteur de la gestion des produits | NGINX

Autres articles de Rajesh Bavanantham