[英]ASP.net Core - comment specific versions in Swagger
我有一個存在版本 1 到 3 的 API。 我正在創建一個特定 controller 的 v4,我需要標題描述(見下文“負責...的 API”)。
有沒有辦法對版本進行具體描述? 我想把“草稿”這個詞放到我的新 v4 中。
我的啟動配置如下...
服務集合
...
services.AddSwaggerGen(c =>
{
services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();
var dir = new DirectoryInfo(AppDomain.CurrentDomain.BaseDirectory);
foreach (var fi in dir.EnumerateFiles("*.xml"))
{
c.IncludeXmlComments(fi.FullName);
}
c.AddSecurityDefinition("Bearer",
new OpenApiSecurityScheme
{
In = ParameterLocation.Header,
Description = "Please insert JWT with Bearer into field",
Name = "Authorization",
Type = UseOpenApiV2 ? SecuritySchemeType.ApiKey : SecuritySchemeType.Http,
Scheme = "bearer",
BearerFormat = "JWT",
});
c.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{
new OpenApiSecurityScheme
{
Reference = new OpenApiReference
{Type = ReferenceType.SecurityScheme, Id = "Bearer"},
},
new string[0]
}
});
c.DocumentFilter<IncludeHostDocumentFilter>();
});
services.AddSwaggerGenNewtonsoftSupport();
...
配置
public void Configure(IApplicationBuilder app, IHostingEnvironment env, IApiVersionDescriptionProvider provider)
{
if (!env.IsEnvironment("PROD"))
{
app.UseSwagger();
app.UseSwaggerUI(o =>
{
foreach (var description in provider.ApiVersionDescriptions)
{
o.SwaggerEndpoint($"/swagger/{description.GroupName}/swagger.json", description.GroupName.ToUpperInvariant());
}
o.RoutePrefix = "swagger";
});
}
app.UseCors("CorsPolicy");
app.UseAuthentication();
app.UseRequestResponseLogging();
app.UseMvcWithDefaultRoute();
}
感謝您的任何指點!
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.