如何为Azure Functions v3配置Swagger UI的全局API名称、版本等信息

你使用的ConfigureOpenApi()方法存在支持全局元数据配置的重载，直接传入配置委托即可修改Swagger页面展示的全局API名称、版本等信息，修改后的Program.Main()代码如下：

public static void Main()
{
    var host = new HostBuilder()
        .ConfigureFunctionsWorkerDefaults(worker => worker.UseNewtonsoftJson())
        // 添加配置委托修改全局OpenAPI元数据
        .ConfigureOpenApi(options =>
        {
            options.Title = "你的自定义API名称";
            options.Version = "v1.0.0";
            options.Description = "这是项目API的全局描述信息";
            // 可选配置：联系人信息
            options.Contact = new Microsoft.OpenApi.Models.OpenApiContact
            {
                Name = "技术支持",
                Email = "support@example.com"
            };
            // 可选配置：许可证信息
            options.License = new Microsoft.OpenApi.Models.OpenApiLicense
            {
                Name = "MIT许可证"
            };
        })
        .ConfigureServices(services =>
            {
                services.AddLogging();
            }
        )
        .Build();
    host.Run();
}

常用可配置参数说明 #

• Title：Swagger UI页面顶部展示的全局API名称
• Version：API的版本标识，会和标题一同展示在页面头部
• Description：API的全局功能说明，展示在标题下方
• TermsOfService：可选，服务条款的URI地址
• Contact：可选，API维护方的联系信息
• License：可选，API的使用许可证说明

配置完成后重新启动应用，访问~/api/swagger/ui即可看到修改后的全局信息。

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