存在するバージョン 1 から 3 の API があります。特定のコントローラーの v4 を作成していて、見出しの説明が必要です (以下の「担当する API」を参照)。
バージョンに特定の説明を付ける方法はありますか? 新しい v4 に「DRAFT」という単語を入れたいです。
私のスタートアップは次のように構成されています...
ServiceCollection
...
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();
}
ご指摘ありがとうございます。