diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj b/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj index 47373297f2ac69a73a5dda6035b13a12e8d351aa..121cb04bd5d6ef8c94fc5f2a9b66e3bd6e711047 100644 --- a/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/Microsoft.Extensions.Configuration.Json.csproj @@ -6,7 +6,8 @@ true true true - JSON configuration provider implementation for Microsoft.Extensions.Configuration. + JSON configuration provider implementation for Microsoft.Extensions.Configuration. This package enables you to read your application's settings from a JSON file. You can use JsonConfigurationExtensions.AddJsonFile extension method on IConfigurationBuilder to add the JSON configuration provider to the configuration builder. + README.md @@ -17,6 +18,7 @@ + diff --git a/src/libraries/Microsoft.Extensions.Configuration.Json/src/README.md b/src/libraries/Microsoft.Extensions.Configuration.Json/src/README.md new file mode 100644 index 0000000000000000000000000000000000000000..869626b27e8c265da0f0e4e02593a3fb4299ee12 --- /dev/null +++ b/src/libraries/Microsoft.Extensions.Configuration.Json/src/README.md @@ -0,0 +1,66 @@ +## About + +JSON configuration provider implementation for [Microsoft.Extensions.Configuration](https://www.nuget.org/packages/Microsoft.Extensions.Configuration/). This package enables you to read your application's settings from a JSON file. You can use [JsonConfigurationExtensions.AddJsonFile](https://docs.microsoft.com/dotnet/api/microsoft.extensions.configuration.jsonconfigurationextensions.addjsonfile) extension method on `IConfigurationBuilder` to add the JSON configuration provider to the configuration builder. + +For more information, see the documentation: + +- [Configuration in .NET](https://docs.microsoft.com/dotnet/core/extensions/configuration) +- [Microsoft.Extensions.Configuration.Json namespace](https://docs.microsoft.com/dotnet/api/microsoft.extensions.configuration.json) + +## Example + +The following example shows how to read application settings from the JSON configuration file. + +```cs +using System; +using Microsoft.Extensions.Configuration; + +class Program +{ + static void Main() + { + // Build a configuration object from JSON file + IConfiguration config = new ConfigurationBuilder() + .AddJsonFile("appsettings.json") + .Build(); + + // Get a configuration section + IConfigurationSection section = config.GetSection("Settings"); + + // Read simple values + Console.WriteLine($"Server: {section["Server"]}"); + Console.WriteLine($"Database: {section["Database"]}"); + + // Read a collection + Console.WriteLine("Ports: "); + IConfigurationSection ports = section.GetSection("Ports"); + + foreach (IConfigurationSection child in ports.GetChildren()) + { + Console.WriteLine(child.Value); + } + } +} +``` + +To run this example, include an `appsettings.json` file with the following content in your project: + +```json +{ + "Settings": { + "Server": "example.com", + "Database": "Northwind", + "Ports": [ 80, 81 ] + } +} +``` + +You can include a configuration file using a code like this in your `.csproj` file: + +```xml + + + Always + + +```