.net 6 Minimal Api Get Configuration

INFLUENCESMAG.ORG

4 min read

·

Jun 03, 2024

36

Share

Accéder à la configuration dans une API minimale .NET 6

Les API minimales dans .NET 6 offrent un moyen simple et efficace de créer des services web. L'un des aspects importants de la construction d'une API est la gestion de la configuration, qui vous permet de stocker et de récupérer des paramètres et des valeurs essentiels pour votre application.

Dans cet article, nous allons explorer comment accéder à la configuration dans une API minimale .NET 6.

Configuration par fichier JSON

La méthode la plus courante pour gérer la configuration dans une API minimale .NET 6 est d'utiliser des fichiers JSON. Ces fichiers peuvent être utilisés pour stocker des paramètres de configuration tels que les chaînes de connexion à la base de données, les URL de l'API et d'autres valeurs spécifiques à l'environnement.

Voici comment accéder à la configuration d'un fichier JSON dans votre API minimale :

1. Créer un fichier JSON de configuration :

   • Dans votre projet, créez un fichier nommé appsettings.json.

   • Ajoutez les paramètres de configuration que vous souhaitez utiliser dans le fichier JSON.

   • Par exemple :

     {
       "ConnectionStrings": {
         "MyDatabase": "Data Source=localhost;Initial Catalog=MyDatabase;Integrated Security=True"
       },
       "ApiUrl": "https://api.example.com"
     }
     

2. Accéder à la configuration dans votre API :

   • Utilisez la classe IConfiguration pour accéder à la configuration.
   • Injectez la classe IConfiguration dans votre contrôleur ou service.
   • Utilisez la méthode GetValue<T>(string key) pour récupérer la valeur d'un paramètre.

   public class MyController
   {
       private readonly IConfiguration _configuration;
   
       public MyController(IConfiguration configuration)
       {
           _configuration = configuration;
       }
   
       [HttpGet]
       public string GetDatabaseConnectionString()
       {
           return _configuration.GetValue("ConnectionStrings:MyDatabase");
       }
   }
   

Configuration par environnement

Vous pouvez également utiliser la configuration pour gérer des paramètres spécifiques à l'environnement. Par exemple, vous pouvez avoir une chaîne de connexion à la base de données différente pour votre environnement de développement et votre environnement de production.

Pour accéder à la configuration d'un environnement spécifique, utilisez la méthode GetSection(string key) de la classe IConfiguration.

public class MyController
{
    private readonly IConfiguration _configuration;

    public MyController(IConfiguration configuration)
    {
        _configuration = configuration;
    }

    [HttpGet]
    public string GetApiUrl()
    {
        var environment = _configuration.GetSection("Environment").Value;
        string apiUrl;
        if (environment == "Development")
        {
            apiUrl = _configuration.GetValue("ApiUrl:Development");
        }
        else 
        {
            apiUrl = _configuration.GetValue("ApiUrl:Production");
        }
        return apiUrl;
    }
}

Conclusion

L'accès à la configuration est essentiel pour la création d'une API flexible et adaptable. Les API minimales dans .NET 6 facilitent la gestion de la configuration grâce à des fichiers JSON et à la prise en charge des environnements.

En utilisant les techniques décrites dans cet article, vous pouvez facilement récupérer des paramètres de configuration et les utiliser dans votre API minimale .NET 6.