Catégories
Start-up et applications

5 conseils pour créer des produits API conviviaux pour les développeurs

Dans une conversation avec Thomas Bush chez Nordic APIs, Rahul Dighe (Paypal’s API Product and Platform Product Leader) explique sa théorie sur la façon dont les grands produits API sont construits délibérément. Cet article développe ses idées concernant le processus délibéré et rigoureux de construction d'API avec une conception intentionnelle pour une utilisation à long terme.

Astuce n ° 1: Une équipe de développeurs soigneusement organisée

Rahul présente une expérience de réflexion décrivant trois types de développeurs qui pourraient utiliser les API PayPal: un pigiste nouvellement inscrit, un expert des paiements avec 10 ans d'expérience dans le domaine et un développeur distrait dont le véritable intérêt est concentré ailleurs. Chaque type de développeur a son propre niveau d'expérience et ses propres exigences. Dans cet esprit, Rahul vous propose de «prendre en compte les modèles d'utilisation de vos archétypes de développeur principal lors de la création de nouvelles API».

Gardant cela à l'esprit, il est également important de se rappeler que l'API n'est pas la fin d'une conception de produit, mais plutôt un chemin vers la fin: les besoins varieront d'une entreprise à la recherche d'un widget non API pour l'intégration, à droite jusqu'à une entreprise à la recherche d'une solution API entièrement étoffée.

Le dernier élément de cette astuce consiste à créer un «pageur unique». Rahul conseille aux équipes de rédiger un bref document décrivant toutes les entrées et sorties, ainsi que les principaux modèles d'intégration que l'API travaillera à prendre en charge. Ce document servira de sorte de mini énoncé de mission auquel l'équipe pourra se référer tout au long du processus de conception.

Astuce n ° 2: faites de la dénomination votre nouvelle obsession

Le nom de l'API sera un point d'ancrage autour duquel l'équipe travaillera pendant longtemps. Rahul explique que "bien que vous puissiez évoluer rapidement, rien ne garantit que vos développeurs le feront aussi." Bush renvoie à un article qu'il a écrit sur le même thème, "10+ Best Practices for Naming API Endpoints".

Conseil n ° 3: respectez votre propre processus

Un concepteur d'API expérimenté peut effectuer la livraison le jour même: «Vous pouvez parcourir les processus de découverte, de conception, de développement et de déploiement, mais vous vous retrouverez avec un produit sous-optimal. Au lieu de cela, respectez l'approche qui fonctionne et acceptez que la création ou la mise à jour d'une API prendra un peu plus de temps que d'autres pourraient le souhaiter. » Pour construire une API solide, il est essentiel de respecter la nécessité de progrès réfléchis dans le processus.

Astuce n ° 4: Construisez l'écosystème complet

Une API n'est que le point de départ. Il est tout aussi important de créer des SDK de qualité, un bac à sable fiable et un personnel d'assistance prêt à gérer les bogues. Ces éléments améliorent la qualité des principaux produits API.

Conseil n ° 5: respectez des normes rigoureuses

Un système de gouvernance API de structures organisationnelles ou de communication internes maintiendra le travail d'une qualité constante. Rahul est guidé par la loi de Conway dans cette réflexion.

Dernier point à retenir

Les meilleures API sont construites avec des règles de base de conception ancrées dans le bon sens. Une gouvernance unitaire basée sur des normes rigoureuses, connaissant bien vos développeurs cibles, une nomenclature réfléchie et accordant autant d'attention aux actifs de support que le produit principal.

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *