Les paramètres facultatifs dans Minimal API avec .NET 6
Minimal API est une nouvelle façon de créer des API Web avec .NET 6, offrant un moyen simple et efficace de développer des services Web légers. L'un des aspects importants des API Web est la gestion des paramètres d'entrée, et la possibilité d'inclure des paramètres facultatifs est essentielle pour une flexibilité maximale.
Pourquoi utiliser des paramètres facultatifs ?
Les paramètres facultatifs dans Minimal API vous permettent de créer des API plus flexibles et faciles à utiliser. Imaginez une API qui récupère des informations sur les utilisateurs. Si vous souhaitez que l'utilisateur puisse fournir un nom pour filtrer les résultats, vous pouvez rendre ce paramètre facultatif. Si l'utilisateur ne fournit pas de nom, l'API retournera tous les utilisateurs.
Comment utiliser des paramètres facultatifs dans Minimal API ?
Il existe plusieurs façons de gérer les paramètres facultatifs dans Minimal API :
1. Utilisation de [FromQuery] et string?:
app.MapGet("/users", (string? name) =>
{
// Si le nom est fourni, filtrez les utilisateurs
if (!string.IsNullOrEmpty(name))
{
// Logique pour filtrer les utilisateurs par nom
}
else
{
// Logique pour récupérer tous les utilisateurs
}
});
2. Utilisation de [FromBody] et de classes C#:
public class UserFilter
{
public string? Name { get; set; }
}
app.MapPost("/users", (UserFilter filter) =>
{
// Si le nom est fourni, filtrez les utilisateurs
if (!string.IsNullOrEmpty(filter.Name))
{
// Logique pour filtrer les utilisateurs par nom
}
else
{
// Logique pour récupérer tous les utilisateurs
}
});
3. Utilisation de HttpContext.Request.Query:
app.MapGet("/users", (HttpContext context) =>
{
string? name = context.Request.Query["name"];
// Si le nom est fourni, filtrez les utilisateurs
if (!string.IsNullOrEmpty(name))
{
// Logique pour filtrer les utilisateurs par nom
}
else
{
// Logique pour récupérer tous les utilisateurs
}
});
Quelle que soit la méthode choisie, il est important de gérer correctement les paramètres facultatifs pour assurer la robustesse et la flexibilité de votre API.
Conclusion
Les paramètres facultatifs sont un élément essentiel de la conception d'API Web flexibles et conviviales. Minimal API de .NET 6 offre plusieurs options pour gérer les paramètres facultatifs, vous permettant de créer des API plus robustes et performantes.