Utiliser Swashbuckle pour créer un document OpenAPI
Pour qu’une API web puisse être publiée dans API Management Azure avec Visual Studio, elle doit avoir un document de description OpenAPI.
Le document OpenAPI est utilisé par API Management pour détecter les points de terminaison de l’API web. Il est plus facile que jamais pour les développeurs VanArsdel de créer une description OpenAPI de leurs API web à l’aide des outils Swashbuckle.
Qu’est-ce que OpenAPI et que fait-il ?
Le document OpenAPI définit une description d’interface standard et indépendante du langage de programmation pour les API web. Il permet aux êtres humains et aux ordinateurs de découvrir et de comprendre les fonctionnalités d’un service sans avoir accès au code source, à une documentation supplémentaire ni à une inspection du trafic réseau.
Le document OpenAPI est un contrat pour les API web. C’est tout ce dont une application consommatrice a besoin pour comprendre les API web et communiquer avec elles, sans avoir à savoir où elles se trouvent ni si elles sont en cours d’exécution.
Générer un document OpenAPI à partir d’une application API web ASP.NET Core
Il existe plusieurs façons de générer le document OpenAPI à partir de votre application API web ASP.NET Core. Swashbuckle est le moyen le plus courant de le faire.
Facile à utiliser et, une fois installé sur votre application, il affiche automatiquement l’écran de l’écran de l’interface utilisateur Swagger.
Swashbuckle génère également le document OpenAPI à la volée, qui comprend tous les détails du point de terminaison d’API, les structures de charge utile, les exigences en matière de sécurité, etc. Voici l’exemple de document d’API web de VanArsdel pour la gestion des inventaires.
Dans la leçon suivante, un exercice vous montre comment activer cette fonctionnalité OpenAPI sur votre application API web ASP.NET Core.