Résumé
Une documentation riche rend une API plus facile à utiliser et à gérer. Dans l’exemple de ce module, vous avez utilisé Swashbuckle et Swagger afin de autogénérer une documentation OpenAPI pour votre API ASP.NET Core.
L’ajout de packages Swashbuckle à votre projet vous permet de disposer d’une documentation OpenAPI professionnelle. Swagger UI rend la documentation OpenAPI facile à lire sans que le consommateur ait à connaître le code source de l’API.
Vous avez également découvert comment améliorer la documentation Swagger par défaut au moyen d’annotations et de commentaires XML.
En savoir plus
- Bien démarrer avec OpenAPI
- Bien démarrer avec Swagger
- Swashbuckle
- Interface CLI .NET Swashbuckle
- Swagger pour node