我使用以下命令将 OpenApi 支持添加到 Azure 函数应用程序 (v3).ConfigureOpenApi()
in Program.Main()
。我对特定功能使用函数装饰,但如何控制 ~/api/swagger/ui 上显示的通用 API 名称、版本等?
这是我的Program.Main()
code:
public static void Main()
{
var host = new HostBuilder()
.ConfigureFunctionsWorkerDefaults(worker => worker.UseNewtonsoftJson())
.ConfigureOpenApi()
.ConfigureServices(services =>
{
services.AddLogging();
}
)
.Build();
host.Run();
}
}
要控制 API 元信息,您应该定义一个类来实现IOpenApiConfigurationOptions
(位于命名空间Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Abstractions
).
注意:应该只有一个实现IOpenApiConfigurationOptions
项目中的接口。类名称空间或可见性似乎并不重要。
最简单的方法就是继承DefaultOpenApiConfigurationOptions
由...提供Microsoft.Azure.WebJobs.Extensions.OpenApi.Core
并覆盖特定属性。
将包含以下内容的文件添加到您的项目(并更新必要的值):
using System;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Configurations;
using Microsoft.Azure.WebJobs.Extensions.OpenApi.Core.Enums;
using Microsoft.OpenApi.Models;
namespace MyApp
{
internal class OpenApiConfigurationOptions : DefaultOpenApiConfigurationOptions
{
public override OpenApiInfo Info { get; set; } = new OpenApiInfo
{
Version = "1.0.0",
Title = "My API",
Description = "My API description",
License = new OpenApiLicense
{
Name = "MIT",
Url = new Uri("http://opensource.org/licenses/MIT"),
}
};
public override OpenApiVersionType OpenApiVersion { get; set; } = OpenApiVersionType.V3;
}
}
Microsoft 提供了一些示例项目,可以在这里找到 https://github.com/Azure/azure-functions-openapi-extension/blob/main/samples
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)