Démarrer avec Minimal API et Swagger dans .NET 6
Minimal API est une nouvelle fonctionnalité dans .NET 6 qui permet de créer des API web légères et rapides. Swagger est un outil populaire pour documenter et tester des API. Combiner ces deux outils vous permet de créer des API web puissantes et bien documentées avec un minimum de code.
Configuration de Minimal API avec Swagger
Commençons par créer un projet .NET 6 Minimal API. Vous pouvez le faire en utilisant la commande suivante dans votre console:
dotnet new web -o MyMinimalApi
Ensuite, installez les packages NuGet nécessaires pour Swagger:
dotnet add package Swashbuckle.AspNetCore
Dans votre fichier Program.cs, ajoutez le code suivant pour configurer Swagger:
var builder = WebApplication.CreateBuilder(args);
// Ajout de Swagger
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
var app = builder.Build();
// Configuration de Swagger
app.UseSwagger();
app.UseSwaggerUI();
// ... Autres configurations
app.Run();
Utilisation de Swagger
Après avoir exécuté votre application, vous pouvez accéder à la documentation Swagger en navigant vers http://localhost:5000/swagger/index.html. Vous trouverez une interface interactive qui vous permet de visualiser les points de terminaison de votre API, de voir les paramètres requis et de tester les requêtes HTTP.
Exemple d'API Minimal avec Swagger
Voici un exemple simple d'une API Minimal qui renvoie une liste de produits:
app.MapGet("/products", () =>
{
return new List
{
new Product { Id = 1, Name = "Produit 1" },
new Product { Id = 2, Name = "Produit 2" }
};
});
public class Product
{
public int Id { get; set; }
public string Name { get; set; }
}
Lorsque vous exécutez votre application et que vous accédez à http://localhost:5000/swagger/index.html, vous trouverez le point de terminaison /products documenté dans Swagger. Vous pouvez tester ce point de terminaison en envoyant une requête GET à l'aide de l'interface Swagger.
Conclusion
Minimal API et Swagger sont des outils puissants qui simplifient le développement et la documentation des API web. En les combinant, vous pouvez créer des API robustes et bien documentées avec un minimum d'efforts. Utilisez cette configuration pour améliorer vos projets .NET 6 et garantir une meilleure communication et collaboration entre votre équipe de développement et vos utilisateurs.