Annonce de mises à jour de l’expérience d’API REST
Ce billet a été écrit par Jessie Huang, Chef de programme dans l’équipe docs.microsoft.com.
Aujourd’hui, nous sommes heureux d’annoncer la publication de deux améliorations clés de l’expérience REST sur docs.microsoft.com :
- Préversion du navigateur d’API REST : un moyen simple de rechercher et de découvrir les API REST développées par Microsoft.
- Essayer REST : une expérience interactive qui vous permet d’essayer des API REST directement dans votre navigateur web préféré.
Découvrir les API REST au même endroit
Si vous êtes déjà familiarisé avec l’une de nos expériences de navigateur d’API, par exemple, celle de .NET, PowerShell, Python ou JavaScript, vous vous sentirez à l’aise avec cette nouvelle version : elle vous permet d’obtenir rapidement de la documentation pour un grand nombre d’API REST sans dépendre d’une expérience de recherche moins ciblée. Le navigateur d’API vous permet de trouver exactement l’API que vous cherchez en quelques secondes.
Auparavant, pour rechercher une documentation d’API REST spécifique sur docs.microsoft.com, vous deviez éventuellement utiliser notre recherche dans tout le site ou un des composants de navigation des pages de contenu, comme la table des matières. Cette approche peut prendre du temps, en particulier quand vous savez exactement ce que vous cherchez. Nous avons voulu faciliter la démarche.
À partir d’aujourd’hui, vous pouvez découvrir les API REST de Microsoft de façon beaucoup plus efficace dans un endroit centralisé https://docs.microsoft.com/rest/api. Sélectionnez simplement un service dans la liste déroulante pour rechercher toutes les API de service disponibles :
Vous avez besoin d’enregistrer un clic ? Pour certaines des API que vous utilisez le plus souvent, vous pouvez toujours compter sur les Filtres rapides : si vous cliquez sur l’un d’entre eux, vous voyez instantanément un ensemble complet d’API correspondant à un service donné, pour la version la plus récente :
Nous avons conçu l’expérience de recherche pour vous permettre de trouver les informations d’API dont vous avez besoin, que vous connaissiez les mots clés exacts ou non, et même si vous ne connaissez pas le service de l’API concernée ! Par défaut, nous lançons la recherche dans toutes les API documentées sur docs.microsoft.com. La recherche se produit dans l’étendue d’un service uniquement quand vous sélectionnez ce service.
Vous avez besoin de rechercher plusieurs mots clés à la fois ? C’est également possible !
Essayer les API REST Azure dans votre navigateur
Vous avez trouvé une API Azure qui vous intéresse, mais vous ne savez pas si c’est celle qu’il vous faut pour votre scénario ? Ne vous inquiétez pas, car à partir d’aujourd’hui vous pouvez essayer les API REST Azure directement dans votre navigateur, sur docs.microsoft.com !
Tout ce que vous avez à faire est d’appuyer sur le bouton vert Essayer :
Dès que vous sélectionnez Essayer pour une API REST, vous êtes dirigé vers une vue ciblée, où vous pouvez expérimenter différentes valeurs de paramètre ou corps de demande. Vous pouvez tout aussi facilement changer le contexte de l’article à partir du menu hamburger Contenu en haut à gauche de la page :
Vos commentaires nous intéressent
Nous prévoyons d’implémenter de nombreuses améliorations à court terme, cette expérience n’est donc en aucun cas définitive. Par exemple, nous comptons activer Essayer pas seulement pour les API REST Azure. Faites-nous part de vos suggestions pour améliorer notre expérience REST, il vous suffit d’ouvrir un nouveau ticket et nous vous contacterons dans les meilleurs délais.
Vous pouvez également suivre notre compte Twitter pour obtenir les dernières mises à jour et notifications !
Vous rêvez d’un monde meilleur pour les développeurs ? Rejoignez notre équipe !