Intégration de Swagger dans une application .NET Core : un exemple pratique
Introduction
Swagger est un outil puissant pour la documentation et la découverte d'API REST. Il permet de générer automatiquement une interface interactive pour votre API, facilitant ainsi son utilisation et sa compréhension par les développeurs. Dans cet article, nous allons explorer comment intégrer Swagger dans une application .NET Core, en utilisant un exemple concret.
Configuration de Swagger
1. Installation des packages NuGet
Commencez par installer les packages NuGet nécessaires :
Install-Package Swashbuckle.AspNetCore
2. Configuration de Swagger dans le fichier Startup.cs
Ajoutez les lignes suivantes dans la méthode ConfigureServices de votre classe Startup.cs :
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo
{
Title = "Mon API .NET Core",
Version = "v1",
Description = "Documentation de l'API",
Contact = new OpenApiContact
{
Name = "Votre nom",
Email = "[email protected]",
Url = new Uri("https://votresite.com"),
},
});
});
3. Activation de l'interface Swagger
Ajoutez les lignes suivantes dans la méthode Configure de votre classe Startup.cs :
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Mon API .NET Core v1");
});
Exemple d'API avec Swagger
Créons une API simple avec une seule méthode Get qui renvoie une liste de produits.
1. Créer un modèle de produit
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
public decimal Price { get; set; }
}
2. Créer un contrôleur d'API
[ApiController]
[Route("api/[controller]")]
public class ProductsController : ControllerBase
{
[HttpGet]
public IEnumerable Get()
{
return new List
{
new Product { Id = 1, Name = "Produit 1", Price = 10.99m },
new Product { Id = 2, Name = "Produit 2", Price = 20.99m },
};
}
}
3. Configuration de Swagger pour la documentation
Ajoutez les attributs suivants au-dessus de la méthode Get dans le contrôleur :
[HttpGet]
[ProducesResponseType(typeof(IEnumerable), StatusCodes.OK)]
[ProducesResponseType(StatusCodes.BadRequest)]
public IEnumerable Get()
{
// ...
}
4. Lancer l'application
Exécutez votre application .NET Core et accédez à l'adresse http://localhost:5000/swagger/index.html. Vous devriez voir l'interface interactive de Swagger avec la documentation de votre API, y compris des exemples de requêtes et de réponses.
Conclusion
L'intégration de Swagger dans une application .NET Core est un processus simple qui offre de nombreux avantages pour la documentation et la découverte d'API REST. En utilisant des attributs et des configurations simples, vous pouvez générer une interface interactive pour votre API, facilitant ainsi son utilisation et sa compréhension par les développeurs.
N'hésitez pas à expérimenter avec les fonctionnalités de Swagger pour enrichir la documentation de votre API. Avec sa facilité d'utilisation et ses fonctionnalités puissantes, Swagger est un outil indispensable pour tout développeur d'API .NET Core.