.NET 5.0 options pattern using JSON array

Question

I am building a C# .NET 5.0 application to talk to an external API for which we have multiple accounts that we can post data to. I am trying to store these details in appsettings.json file and use the options pattern to retrieve the settings.

I have the following structure in my app settings.json

"SomeApi": {
    "Url": "https://api.someapi.net/v3/",
    "Secret": "mysecretvlaue",
    "ClientId": "myclientid",
    "Accounts": [
      {
          "Name": "Bob",
          "Username": "HisUsername",
          "Password": "HisPassword",
          "PostingLocation": "HisLocation"
      },
      {
          "Name": "Fred",
          "Username": "HisUsername",
          "Password": "HisPassword",
          "PostingLocation": "HisLocation"
      }
    ]
  },

I have a class set up like this:

public class SomeApiOptions
    {
        public const string SomeApi = "SomeApi";
   
        public string Url { get; set; }
        public string Secret { get; set; }
        public string ClientId { get; set; }

        public List<Account> Accounts { get; set; }
    }
    public class Account
    {
        string Name { get; set; }
        string Username { get; set; }
        string Password { get; set; }
        string PostingLocation { get; set; }
    }

My startup.cs has this:

services.Configure<SomeApiOptions>(Configuration.GetSection(SomeApiOptions.SomeApi));

Finally, I inject IOptions to the class where I need to use the settings like so:

Public MyClass (IOptionsSnapshot<SomeApiOptions> options)

The issue I am having is the Accounts never get populated with their respective values. Url, Secret etc. are populated and the number of elements items in the Accounts list is correct, but all of the properties have null values.

I have looked at similar questions and tried restructuring my JSON a few ways but still end up with null values.

Any help greatly appreciated.

I see a couple of problems here. First, none of the properties in the Account class are public so you need to change that. Second, the Location property doesn't match the JSON which is PostingLocation. — DavidG
– DavidG, Commented May 7, 2021 at 9:18
In JSON there is property called PostingLocation while its name in object is Location try to make them same or... add data Annotation to your object — Ibram Reda
– Ibram Reda, Commented May 7, 2021 at 9:18

DavidG · Accepted Answer · 2021-05-07 09:19:20Z

2

I see a couple of problems here.

First, none of the properties in the Account class are public so you need to change that:

Second, the Location property doesn't match the JSON which is PostingLocation. Your class should be:

public class Account
{
    public string Name { get; set; }
    public string Username { get; set; }
    public string Password { get; set; }
    public string PostingLocation { get; set; }
}

answered May 7, 2021 at 9:19

DavidG

120k13 gold badges232 silver badges239 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Bandito Over a year ago

Apologies, that was a typo, I have edited the post to reflect the PostingLocation is as you describe.

DavidG Over a year ago

The properties still need to be public though, that's your real problem.

Bandito Over a year ago

Thanks! I can't believe I missed that. Public properties solved the issue immediately.

Collectives™ on Stack Overflow

.NET 5.0 options pattern using JSON array

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related