.net 6 Swagger Enum As String

3 min read Jun 03, 2024

Intégration de Swagger avec des énumérations dans .NET 6 : Affichage des valeurs de chaîne

En utilisant Swagger avec .NET 6, il est possible d'afficher les valeurs de chaîne des énumérations dans la documentation API. Cela permet aux développeurs de comprendre facilement les valeurs possibles d'une énumération et d'utiliser l'API de manière plus efficace.

Problème : Affichage par défaut des énumérations

Par défaut, Swagger affiche les énumérations avec leurs valeurs numériques. Cela peut être problématique car les valeurs numériques ne sont pas toujours intuitives pour les développeurs.

Solution : Utiliser l'attribut `[EnumDataType]`

Pour afficher les valeurs de chaîne des énumérations dans Swagger, il est nécessaire d'utiliser l'attribut [EnumDataType] sur la propriété de l'énumération. Cet attribut indique à Swagger de traiter l'énumération comme un type de données de chaîne.

Voici un exemple :

public enum Status
{
    [EnumMember(Value = "Pending")]
    Pending,
    [EnumMember(Value = "Approved")]
    Approved,
    [EnumMember(Value = "Rejected")]
    Rejected
}

public class MyDto
{
    [EnumDataType(typeof(Status))]
    public Status Status { get; set; }
}

Explication:

L'attribut [EnumMember(Value = "...")] permet de spécifier la valeur de chaîne à afficher pour chaque valeur de l'énumération.
L'attribut [EnumDataType] est appliqué à la propriété Status du modèle MyDto.

Avantages d'utiliser des valeurs de chaîne pour les énumérations

Meilleure lisibilité: Les valeurs de chaîne sont plus faciles à comprendre pour les développeurs que les valeurs numériques.
Documentation améliorée: Swagger affiche les valeurs de chaîne dans la documentation de l'API, ce qui améliore la clarté et la précision.
Fiabilité: L'utilisation de valeurs de chaîne garantit que les valeurs de l'énumération sont interprétées correctement par les clients de l'API.

Conclusion

En utilisant l'attribut [EnumDataType], vous pouvez facilement intégrer des énumérations dans Swagger et afficher leurs valeurs de chaîne dans la documentation API. Cela permet d'améliorer la lisibilité, la documentation et la fiabilité de votre API. N'oubliez pas de toujours utiliser des valeurs de chaîne pour les énumérations, car cela rend votre API plus accessible et plus facile à utiliser.