新しいCore
Web APIを開始し、Swagger
をアプリケーションに追加したいと考えています。
私の現在の環境:
これが私のStartup.cs
クラスと構成:
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
//AK: Enable CORS
//CORS should be configured on Host server.
services.AddCors(setupAction =>
{
setupAction.AddPolicy(DevCorsPolicyName,
builder =>
{
builder.WithOrigins("*").AllowAnyHeader().AllowAnyMethod();
});
});
#region Configuration
//Configuration File
services.Configure<AppSettingConfiguration>(Configuration.GetSection("AppSettings"));
//AutoMapper
services.AddAutoMapper(AppDomain.CurrentDomain.GetAssemblies());
//Configure Swagger
services.ConfigureSwaggerGen(c =>
{
c.SwaggerDoc("v3", new OpenApiInfo
{
Title = "GTrackAPI",
Version = "v3"
});
});
#endregion
#region Dependency Injection
//Database context and repository
services.AddDbContext<IGTrackContext, GTrackContext>(builder =>
{
builder.UseSqlServer(connectionString: Configuration.GetConnectionString("gtrackConnection"), sqlServerOptionsAction: null);
});
services.AddScoped<IGTrackRepository, GTrackRepository>();
//facade layers
services.AddScoped<IPersonFacade, PersonFacade>();
//Service layers
services.AddScoped<IPersonService, PersonService>();
#endregion
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
//Enable development environment only settings
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
//AK: Only allow all origins for development environmnet
app.UseCors(DevCorsPolicyName);
// Enable middleware to serve generated Swagger as a JSON endpoint.
app.UseSwagger();
// Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.),
// specifying the Swagger JSON endpoint.
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "GTrackAPI");
c.RoutePrefix = string.Empty; //Configures swagger to load at application root
});
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}
アプリケーションを実行すると、次のエラーが発生します。
InvalidOperationException:ミドルウェア「Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware」を呼び出そうとしているときに、タイプ「Swashbuckle.AspNetCore.Swagger.ISwaggerProvider」のサービスを解決できません。
これがStacktrace
です:
System.InvalidOperationException:ミドルウェア「Swashbuckle.AspNetCore.Swagger.SwaggerMiddleware」を呼び出そうとしているときに、タイプ「Swashbuckle.AspNetCore.Swagger.ISwaggerProvider」のサービスを解決できません。 Microsoft.AspNetCore.Builder.UseMiddlewareExtensions.GetService(IServiceProvider sp、Type type、Type middleware)at lambda_method(Closure、Object、HttpContext、IServiceProvider)at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions。<> c__DisplayClass4_1.b_Context(Context) Microsoft.AspNetCore.Cors.Infrastructure.CorsMiddleware.Invoke(HttpContext context、ICorsPolicyProvider corsPolicyProvider)at Microsoft.AspNetCore.Builder.UseMiddlewareExtensions。<> c__DisplayClass4_1.b__2(HttpContext context)at Microsoft.AspNetCore.Diagnostics.DeveloperContextPageMiddleware.InjectokeContextInvokeContextIndokeContextInvoke(ContextContext)
ここに何かが欠けているのは明らかですが、正確には何なのかわかりません。任意の助けいただければ幸いです。
への呼び出し
services.AddSwaggerGen();
ConfigureServices
に不足しているようです。
public static IServiceCollection AddSwaggerGen(
this IServiceCollection services,
Action<SwaggerGenOptions> setupAction = null)
{
// Add Mvc convention to ensure ApiExplorer is enabled for all actions
services.Configure<MvcOptions>(c =>
c.Conventions.Add(new SwaggerApplicationConvention()));
// Register generator and it's dependencies
services.AddTransient<ISwaggerProvider, SwaggerGenerator>();
services.AddTransient<ISchemaGenerator, SchemaGenerator>();
services.AddTransient<IApiModelResolver, JsonApiModelResolver>();
// Register custom configurators that assign values from SwaggerGenOptions (i.e. high level config)
// to the service-specific options (i.e. lower-level config)
services.AddTransient<IConfigureOptions<SwaggerGeneratorOptions>, ConfigureSwaggerGeneratorOptions>();
services.AddTransient<IConfigureOptions<SchemaGeneratorOptions>, ConfigureSchemaGeneratorOptions>();
// Used by the <c>dotnet-getdocument</c> tool from the Microsoft.Extensions.ApiDescription.Server package.
services.TryAddSingleton<IDocumentProvider, DocumentProvider>();
if (setupAction != null) services.ConfigureSwaggerGen(setupAction);
return services;
}
これは、ISwaggerProvider
をサービスコレクションに追加するものです
現在のコードをリファクタリングして
//...
//Configure Swagger
services.AddSwaggerGen(c => { //<-- NOTE 'Add' instead of 'Configure'
c.SwaggerDoc("v3", new OpenApiInfo {
Title = "GTrackAPI",
Version = "v3"
});
});
//...
ソースコードからわかるように、最終的にはセットアップアクションでConfigureSwaggerGen
を呼び出します。