如何在ASP.NET Core 6 Web API中导出完整的appsettings.json文件

实现思路 #

直接读取对应环境的配置文件并返回原始JSON，无需依赖配置系统的键值对解析，适配配置结构的动态变更。

具体实现步骤 #

• 注入IWebHostEnvironment获取当前环境名称，确定要读取的配置文件名
• 拼接文件路径，读取原始JSON内容
• 创建GET接口返回读取到的JSON

代码示例（Program.cs 极简写法） #

var builder = WebApplication.CreateBuilder(args);

builder.Services.AddControllers();
var app = builder.Build();

app.MapControllers();

// 定义返回配置的接口
app.MapGet("/api/appsettings", (IWebHostEnvironment env) =>
{
    var configFileName = $"appsettings.{env.EnvironmentName}.json";
    var configPath = Path.Combine(env.ContentRootPath, configFileName);

    // 环境配置文件不存在时回退到基础配置
    if (!File.Exists(configPath))
    {
        configPath = Path.Combine(env.ContentRootPath, "appsettings.json");
    }

    var jsonContent = File.ReadAllText(configPath);
    return Results.Json(System.Text.Json.JsonDocument.Parse(jsonContent));
})
.WithName("GetAppSettings")
.WithOpenApi();

app.Run();

控制器模式写法 #

using Microsoft.AspNetCore.Mvc;
using Microsoft.Extensions.Hosting;

[ApiController]
[Route("api/[controller]")]
public class AppSettingsController : ControllerBase
{
    private readonly IWebHostEnvironment _env;

    public AppSettingsController(IWebHostEnvironment env)
    {
        _env = env;
    }

    [HttpGet]
    public IActionResult Get()
    {
        var configFileName = $"appsettings.{_env.EnvironmentName}.json";
        var configPath = Path.Combine(_env.ContentRootPath, configFileName);

        if (!File.Exists(configPath))
        {
            configPath = Path.Combine(_env.ContentRootPath, "appsettings.json");
        }

        var jsonContent = System.IO.File.ReadAllText(configPath);
        return Content(jsonContent, "application/json");
    }
}

注意事项 #

• 安全风险：生产环境暴露完整配置可能泄露敏感信息，建议添加身份验证或访问限制
• 权限检查：确保应用对配置文件所在目录有读取权限
• 环境变量：当前环境由ASPNETCORE_ENVIRONMENT变量控制，部署时需确认该变量设置正确

内容的提问来源于stack exchange，提问作者user1451111