ASP NET Core Get Json Array using IConfiguration

Question

In appsettings json           MyArray                str1              str2              str3                In Startup cs  public void ConfigureServices IServiceCollection services         services AddSingleton lt IConfiguration gt  Configuration         In HomeController  public class HomeController   Controller       private readonly IConfiguration  config      public HomeController IConfiguration config                this  config   config             public IActionResult Index                 return Json  config GetSection  MyArray                 There are my codes above  I got  null How to get the array

User · Answer

public class MyArray   List lt string gt       services Configure lt ShipmentDetailsDisplayGidRoles gt  Configuration GetSection  quot MyArray quot      public SomeController IOptions lt MyArray gt  myArrayOptions        myArray   myArrayOptions Value

User · Answer

Recently I also had a need to read a simple array of strings from an appsettings json file  and other similar  json configuration files   For my approach  I created a simple extension method that does the trick  public static class IConfigurationRootExtensions       public static string   GetArray this IConfigurationRoot configuration  string key                var collection   new List lt string gt             var children   configuration GetSection key   GetChildren            if  children    null                        foreach  var child in children  collection Add child Value                     return collection ToArray             The original poster s  json file looked as follows           quot MyArray quot                quot str1 quot              quot str2 quot              quot str3 quot             Using the above extension method  it makes reading this array a very simple one-line affair  as seen in the following example  var configuration   new ConfigurationBuilder   AddJsonFile  quot appsettings json quot   Build    string   values   configuration GetArray  quot MyArray quot     At runtime  setting a breakpoint with a  QuickWatch  on values verifies that we have successfully read the values from the  json configuration file into a string array

User · Answer

appsettings json   quot MySetting quot        quot MyValues quot          quot C  quot        quot ASP NET quot        quot SQL quot          MySetting class  namespace AspNetCore API Models       public class MySetting   IMySetting               public string   MyValues   get  set               public interface IMySetting               string   MyValues   get  set             Startup cs public void ConfigureServices IServiceCollection services                services Configure lt MySetting gt  Configuration GetSection nameof MySetting         services AddSingleton lt IMySetting gt  sp   gt  sp GetRequiredService lt IOptions lt MySetting gt  gt    Value              Controller cs public class DynamicController   ControllerBase       private readonly IMySetting  mySetting       public DynamicController IMySetting mySetting                this  mySetting   mySetting           Access values  var myValues   this  mySetting MyValues

User · Answer

Kind of an old question  but I can give an answer updated for  NET Core 2 1 with C  7 standards   Say I have a listing only in appsettings Development json such as    TestUsers              UserName    TestUser        Email    Test place com        Password    P ssw0rd                 UserName    TestUser2        Email    Test2 place com        Password    P ssw0rd           I can extract them anywhere that the Microsoft Extensions Configuration IConfiguration is implemented and wired up like so   var testUsers   Configuration GetSection  TestUsers       GetChildren       ToList         Named tuple returns  new in C  7     Select x   gt                        x GetValue lt string gt   UserName               x GetValue lt string gt   Email               x GetValue lt string gt   Password                          ToList lt  string UserName  string Email  string Password  gt       Now I have a list of a well typed object that is well typed   If I go testUsers First    Visual Studio should now show options for the  UserName    Email   and  Password

User · Answer

If you want to pick value of first item then you should do like this-  var item0    config GetSection  MyArray 0      If you want to pick value of entire array then you should do like this-  IConfigurationSection myArraySection    config GetSection  MyArray    var itemArray   myArraySection AsEnumerable      Ideally  you should consider using options pattern suggested by official documentation  This will give you more benefits

User · Answer

In ASP NET Core 2 2 and later we can inject IConfiguration anywhere in our application like in your case  you can inject IConfiguration in HomeController and use like this to get the array   string   array    config GetSection  MyArray   Get lt string   gt

User · Answer

You can get the array direct without increment a new level in the configuration   public void ConfigureServices IServiceCollection services        services Configure lt List lt String gt  gt  Configuration GetSection  MyArray

User · Answer

This worked for me  Create some json file          keyGroups                            Name    group1                keys                      user3                    user4                                                  Name    feature2And3                keys                      user3                    user4                                                  Name    feature5Group                keys                      user5                                    Then  define some class that maps   public class KeyGroup       public string name   get  set        public List lt String gt  keys   get  set        nuget packages   Microsoft Extentions Configuration Binder 3 1 3 Microsoft Extentions Configuration 3 1 3 Microsoft Extentions Configuration json 3 1 3   Then  load it   using Microsoft Extensions Configuration  using System Linq  using System Collections Generic   ConfigurationBuilder configurationBuilder   new ConfigurationBuilder     configurationBuilder AddJsonFile  keygroup json   optional  true  reloadOnChange  true    IConfigurationRoot config   configurationBuilder Build     var sectionKeyGroups    config GetSection  keyGroups    List lt KeyGroup gt  keyGroups    sectionKeyGroups Get lt List lt KeyGroup gt  gt      Dictionary lt String  KeyGroup gt  dict                keyGroups   keyGroups ToDictionary kg   gt  kg name  kg   gt  kg

User · Answer

For the case of returning an array of complex JSON objects from configuration  I ve adapted  djangojazz s answer to use anonymous types and dynamic rather than tuples    Given a settings section of    TestUsers          UserName    TestUser      Email    Test place com      Password    P ssw0rd           UserName    TestUser2      Email    Test2 place com      Password    P ssw0rd         You can return the object array this way   public dynamic GetTestUsers         var testUsers   Configuration GetSection  TestUsers                        GetChildren                        ToList                        Select x   gt  new                           UserName   x GetValue lt string gt   UserName                            Email   x GetValue lt string gt   Email                            Password   x GetValue lt string gt   Password                                return new   Data   testUsers

User · Answer

To get all values of all sections from appsettings json         public static string   Sections      quot LogDirectory quot    quot Application quot    quot Email quot             Dictionary lt string  string gt  sectionDictionary   new Dictionary lt string  string gt              List lt string gt  sectionNames   new List lt string gt  Sections                    sectionNames ForEach section   gt                        List lt KeyValuePair lt string  string gt  gt  sectionValues   configuration GetSection section                       AsEnumerable                        Where p   gt  p Value    null                       ToList                foreach  var subSection in sectionValues                                sectionDictionary Add subSection Key  subSection Value                                     return sectionDictionary

User · Answer

You can install the following two NuGet packages  using Microsoft Extensions Configuration   using Microsoft Extensions Configuration Binder   And then you ll have the possibility to use the following extension method  var myArray    config GetSection  quot MyArray quot   Get lt string   gt

User · Answer

This worked for me to return an array of strings from my config   var allowedMethods   Configuration GetSection  AppSettings CORS-Settings Allow-Methods        Get lt string   gt       My configuration section looks like this    AppSettings          CORS-Settings              Allow-Origins      http   localhost 8000              Allow-Methods      OPTIONS   GET   HEAD   POST   PUT   DELETE

User · Answer

Short form   var myArray  configuration GetSection  MyArray                            AsEnumerable                            Where p   gt  p Value    null                           Select p   gt  p Value                           ToArray      It returns an array of string         str1   str2   str3

User · Answer

If you have array of complex JSON objects like this        MySettings          MyValues              Key    Key1    Value     Value1              Key    Key2    Value     Value2                  You can retrieve settings this way   var valuesSection   configuration GetSection  MySettings MyValues    foreach  IConfigurationSection section in valuesSection GetChildren          var key   section GetValue lt string gt   Key        var value   section GetValue lt string gt   Value

User · Answer

DotNet Core 3 1  Json config   quot TestUsers quot           quot User quot                  quot UserName quot    quot TestUser quot          quot Email quot    quot Test place com quot          quot Password quot    quot P ssw0rd  quot                      quot UserName quot    quot TestUser2 quot          quot Email quot    quot Test2 place com quot          quot Password quot    quot P ssw0rd  quot            Then create a User cs class with auto properties that corresponds to User objects in the Json config above  Then you can reference Microsoft Extensions Configuration Abstractions and do  List lt User gt  myTestUsers   Config GetSection  quot TestUsers quot   GetSection  quot User quot   Get lt List lt User gt  gt

User · Answer

Add a level in your appsettings json         MySettings          MyArray            str1          str2          str3                Create a class representing your section    public class MySettings        public List lt string gt  MyArray  get  set       In your application startup class  bind your model an inject it in the DI service    services Configure lt MySettings gt  options   gt  Configuration GetSection  MySettings   Bind options      And in your controller  get your configuration data from the DI service    public class HomeController   Controller       private readonly List lt string gt   myArray       public HomeController IOptions lt MySettings gt  mySettings                 myArray   mySettings Value MyArray             public IActionResult Index                 return Json  myArray             You can also store your entire configuration model in a property in your controller  if you need all the data    public class HomeController   Controller       private readonly MySettings  mySettings       public HomeController IOptions lt MySettings gt  mySettings                 mySettings   mySettings Value             public IActionResult Index                 return Json  mySettings MyArray             The ASP NET Core s dependency injection service works just like a charm

[c#] ASP.NET Core Get Json Array using IConfiguration

Examples related to c#

Examples related to asp.net-core

Examples related to asp.net-core-mvc