Intégration de Swagger dans une API Web .NET Core : Un guide pratique
Introduction
Swagger est un outil puissant pour documenter et tester vos API Web. Il permet de générer une interface utilisateur interactive qui présente les points de terminaison de votre API, leurs paramètres, les réponses attendues et bien plus encore. Intégrer Swagger dans une application .NET Core est un processus simple et efficace. Dans cet article, nous allons explorer les étapes essentielles pour mettre en place une documentation Swagger pour votre API Web .NET Core.
Installation des packages NuGet
La première étape consiste à installer les packages NuGet nécessaires pour activer Swagger dans votre projet. Ouvrez le gestionnaire de packages NuGet de votre projet et installez les packages suivants :
- Swashbuckle.AspNetCore : Ce package fournit les fonctionnalités principales de Swagger pour .NET Core.
- Swashbuckle.AspNetCore.SwaggerUI : Ce package fournit l'interface utilisateur interactive de Swagger.
Install-Package Swashbuckle.AspNetCore
Install-Package Swashbuckle.AspNetCore.SwaggerUI
Configuration de Swagger
Une fois les packages installés, vous devez configurer Swagger dans votre application .NET Core. Ouvrez le fichier Startup.cs et ajoutez les lignes de code suivantes dans la méthode ConfigureServices :
public void ConfigureServices(IServiceCollection services)
{
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo
{
Title = "Mon API Web",
Version = "v1"
});
});
}
Ce code configure Swagger pour générer de la documentation pour la version "v1" de votre API Web. Vous pouvez modifier le titre et la version si nécessaire.
Configuration de l'interface utilisateur Swagger
Ensuite, vous devez configurer l'interface utilisateur Swagger dans votre application. Ajoutez les lignes de code suivantes dans la méthode Configure de votre fichier Startup.cs :
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
// ...
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Mon API Web v1");
});
// ...
}
Ce code configure SwaggerUI pour afficher la documentation de votre API Web à l'adresse https://[your-app-url]/swagger/v1/swagger.json. Vous pouvez modifier l'URL si nécessaire.
Utilisation de Swagger
Une fois que vous avez configuré Swagger, vous pouvez l'utiliser pour documenter et tester votre API Web. Ouvrez l'URL https://[your-app-url]/swagger dans votre navigateur Web et vous devriez voir l'interface utilisateur de Swagger.
Explorer les points de terminaison
L'interface utilisateur de Swagger vous permet d'explorer les différents points de terminaison de votre API Web. Vous pouvez voir les méthodes HTTP disponibles, les paramètres attendus et les réponses possibles.
Exécuter des requêtes
Vous pouvez également utiliser Swagger pour exécuter des requêtes vers votre API Web. Vous pouvez modifier les paramètres de la requête et exécuter la requête pour voir la réponse de votre API.
Conclusion
Intégrer Swagger dans une API Web .NET Core est un processus simple et efficace. En utilisant Swagger, vous pouvez facilement documenter et tester votre API Web, ce qui facilite la collaboration entre les développeurs et les utilisateurs. N'hésitez pas à explorer les fonctionnalités avancées de Swagger pour améliorer encore la documentation de votre API Web.