BLOG | NGINX

Pourquoi l'expérience du développeur d'API est importante

NGINX-Partie-de-F5-horiz-black-type-RGB
Rajesh Bavanantham Miniature
Rajesh Bavanantham
Publié le 8 septembre 2022

Il s'agit du deuxième article d'une série en deux parties sur API Connectivity Manager :

Les API sont au cœur des entreprises modernes. Bien que les API aient toujours joué un rôle important dans le développement de logiciels, la demande croissante d’intégration de données conduit à une adoption plus large des API dans tous les secteurs d’activité. Mais les API font bien plus que simplement 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. Responsables de la construction, de l'intégration et de la maintenance des API, ils sont à la fois les créateurs et les adoptants techniques des API. Leur expérience, communément appelée expérience de développeur d'API , est l'un des facteurs les plus importants pour déterminer le succès global d'une API. Cet article explore les concepts clés de l'expérience de développeur d'API et ce que les responsables informatiques doivent prendre en compte lors de la planification de l'expérience API.

  1. Quelle est l’expérience du développeur API ?
  2. Pourquoi l’expérience du développeur API est-elle importante ?
  3. Comment créer de formidables expériences de développement d’API ?

Quelle est l’expérience du développeur API ?

L'expérience du développeur d'API décrit les perceptions et émotions globales qu'un développeur éprouve lorsqu'il interagit avec une API. Elle englobe l'infrastructure, les outils, les processus, le support et d'autres points de contact qui contribuent à une expérience agréable et fluide pour les développeurs qui intègrent des API dans leurs applications. L’expérience du développeur d’API est une sous-pratique de l’expérience globale du développeur.

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

Si l’accent mis sans relâche sur l’expérience utilisateur a été le moteur de la première génération d’innovation technologique, la prochaine génération d’entreprises à succès gagnera en se concentrant sur l’ expérience du développeur .

À mesure que l’économie des API continue de se développer, les développeurs acquièrent une plus grande influence sur les API adoptées. Lorsqu'une API est difficile à découvrir, manque de documentation adéquate ou est mal entretenue, les développeurs l'abandonneront au profit d'une alternative plus simple et plus rapide. Cela s’applique aussi bien aux programmes API internes qu’aux API externes pour les partenaires et les clients.

Dans le cas des API externes, l'abandon de votre API par les développeurs peut avoir des conséquences commerciales tangibles. Vous ne perdez pas seulement des revenus provenant de clients directs, mais vous perdez également l'accès à l'écosystème plus vaste de produits et de solutions utilisés par vos clients. Même les programmes d’API internes subissent les conséquences d’une mauvaise expérience de développement, notamment un délai de mise sur le marché plus lent, une productivité réduite des développeurs et une augmentation des retouches, ce qui met potentiellement en péril le succès de votre entreprise.

Pour réussir dans un monde centré sur les développeurs, vous avez besoin d’une stratégie API qui fournit les outils et les ressources appropriés aux développeurs travaillant à chaque étape du cycle de vie de l’API. La meilleure façon d’y parvenir est de créer une expérience API réfléchie de bout en bout pour les développeurs qui englobe trois types d’utilisation d’API :

  • Déploiement et gestion des API
  • Découvrir et tester les API
  • Surveillance et sécurisation des API

Comment créer d’excellentes expériences de développement d’API ?

Pour créer une expérience positive, il faut comprendre comment les développeurs utilisent votre API, ce dont ils ont besoin pour accomplir leurs tâches et, en fin de compte, ce qu'ils ressentent lorsqu'ils utilisent votre API. Une fois que vous avez défini les personnes qui interagiront avec vos API, vous pouvez commencer à planifier l'expérience API globale.

Il y a quatre principes à prendre en compte lors de la conception de l'expérience du développeur d'API :

  1. Identifier les utilisateurs – Qui interagit avec l’API ?
  2. Définir la fonctionnalité – Que fait l’API ?
  3. Optimiser la convivialité – Dans quelle mesure l’API est-elle facile à utiliser ?
  4. Améliorer l’expérience – Quelle sensation procure l’utilisation de l’API ?

Examinons chaque principe et ce que vous devez fournir pour créer une expérience API optimale pour les développeurs.

Étape 1 : Identifier les utilisateurs

Tout comme vous concevez des produits pour des problèmes clients spécifiques, vous devez concevoir l’expérience API sur l’ensemble de votre infrastructure et de vos produits pour répondre aux préoccupations des développeurs. Les développeurs sont bien plus que de simples consommateurs finaux : ils sont également les constructeurs et les mainteneurs de l’infrastructure globale.

Il y a trois personnages principaux à prendre en compte lors de la conception d'une expérience de développeur d'API :

  • Consommateurs d'API : découvrir, mettre en œuvre et maintenir les intégrations d'API pour leurs applications
  • Propriétaires d'API – Planifiez, créez, documentez, testez, déployez et gérez les API pour leurs services
  • Gestionnaires d'infrastructures – Définissez des politiques globales et surveillez les API pour la sécurité et la 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 de développeurs internes, de partenaires et de clients, chacun ayant des personnalités et des exigences différentes.

Étape 2 : Définir la fonctionnalité

La fonction est la base des API réussies. Une bonne API permet aux développeurs d'intégrer des données ou des services précieux, d'effectuer des tâches plus rapidement et de réduire le temps global consacré au développement de nouvelles fonctionnalités. Les principales considérations à prendre en compte sont les suivantes :

  • Quelle valeur l’API offre-t-elle en s’intégrant aux données ou aux services ?
  • Dans quelle mesure l’API résout-elle le problème en réduisant les appels et en structurant les données ?
  • Dans quelle mesure l’API est-elle fiable en termes de disponibilité, de fiabilité et d’évolutivité ?

La fonctionnalité d’une API est étroitement liée à l’approche API-first du développement. Contrairement à la méthode « code first », avec « API first », la spécification de l’API est écrite avant le début du développement du code, en mettant l’accent sur la structure des requêtes API et les données renvoyées. Cette emphase garantit que l’API fournit systématiquement la valeur et les fonctionnalités dont les développeurs ont besoin.

Étape 3 : Optimiser la convivialité

Le troisième principe, la convivialité, aborde la manière dont les développeurs utilisent vos API, plutôt que ce qu’ils peuvent en faire. Il couvre les ressources autour de votre API qui prennent en charge la découverte, l'apprentissage, les tests et l'intégration. Sans un écosystème d’infrastructures, d’outils et de documentation de soutien, les développeurs auront du mal à utiliser vos API. Les considérations importantes incluent :

  • Inscription simple avec authentification unique (SSO) intégrée et gestion facile des clés API
  • Documentation claire et complète avec des références et des exemples de code à jour
  • Temps de configuration rapide avec création d'une demande d'API de base prenant idéalement moins de cinq minutes

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

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

Vous pouvez surmonter ces problèmes en exploitant les portails de développeurs centraux avec une documentation complète, des exemples de code et des outils pour tester les API.

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

L'expérience du développeur d'API est la somme des interactions entre le consommateur d'API et le propriétaire de l'API. La base repose sur la fonctionnalité et la facilité d'utilisation de l'API, mais il existe des interactions supplémentaires qui contribuent au plaisir général de travailler avec une API. Celles-ci peuvent inclure :

  • Communauté active disponible sur des canaux comme Stack Overflow, Slack, Discord, Twitter, etc.
  • Support accessible avec des réponses rapides des équipes de développement
  • Expérience fluide lors de l'interaction avec l'API, la documentation et la communauté

Les développeurs qui aiment travailler avec vos API sont plus susceptibles de les recommander à leurs collègues, de créer de nouvelles fonctionnalités autour d'elles et de les intégrer dans leurs applications.

L'expérience du développeur d'API est importante

La clé d’une excellente expérience de développement d’API inclut votre API ainsi que l’écosystème d’outils, de processus, de documentation et de support qui l’entoure. Lorsque tous les éléments de votre écosystème API fonctionnent de manière transparente, ils réduisent les frictions et la complexité afin que les développeurs puissent se concentrer sur la création applications.

Les étapes décrites ci-dessus font partie d’un processus continu de conception, de mise en œuvre, de test et d’évaluation de l’expérience du développeur d’API. Si vous vous concentrez sur chacune des étapes principales (identification des utilisateurs, définition des fonctionnalités, optimisation de la convivialité et amélioration de 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 avec l'expérience du développeur d'API comme cœur. Avec API Connectivity Manager, les équipes d’infrastructure peuvent déployer des passerelles API et des portails de développeurs hautes performances. Les développeurs peuvent rapidement publier et gérer des API et de la documentation ou découvrir et intégrer des API dans des applications.

Les avantages d'API Connectivity Manager incluent :

  • Intégration rapide – Intégrez-vous à votre fournisseur d’identité préféré pour rationaliser l’autorisation et l’authentification sur le portail des développeurs
  • Documentation simple – Utilisez la spécification OpenAPI pour générer automatiquement la documentation du portail des développeurs lorsque les propriétaires d’API publient des API sur la passerelle API
  • Apprentissage interactif – Permettez aux développeurs de découvrir, de tester et d’apprendre vos API avec un explorateur d’API intégré sur le portail des développeurs
  • Automatisation des flux de travail – Intégrez la publication et la gestion des API dans vos pipelines CI/CD à l'aide d'une API REST entièrement déclarative

Commencer

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

Ressources connexes

Lire plus d'articles de blog sur F5 NGINX ›

« Cet article de blog peut faire référence à des produits qui ne sont plus disponibles et/ou qui ne sont plus pris en charge. Pour obtenir les informations les plus récentes sur les produits et solutions F5 NGINX disponibles, explorez notre famille de produits NGINX . NGINX fait désormais partie de F5. Tous les liens NGINX.com précédents redirigeront vers un contenu NGINX similaire sur F5.com."