Swagger 在 OWIN Startup Web API C# 中不工作
Swagger isn't working in OWIN Startup Web API C#
我在 Web API 的 OWIN startup.cs 文件中实现了 Swagger,但是当我尝试打开 Swagger UI 页面时,它显示 HTTP 错误404.0 - 未找到
URL 检查 Swagger UI: https://localhost:5001/swagger
这是我的实现,请帮我解决我遗漏的问题。
Startup.cs
public class Startup
{
public void Configuration(IAppBuilder app)
{
app.Map("/api", map => { ConfigureApiArea(map); });
}
private void ConfigureApiArea(IAppBuilder map)
{
var config = CreateTypedConfiguration<BaseApiController>();
//Json Settings
JsonFormatterSettings(config);
ConfigureAutofac(config, map);
ConfigureOAuth(map);
config.EnableCors(new EnableCorsAttribute("*", "*", "*", "Paging-Headers,X-Error"));
map.UseCors(Microsoft.Owin.Cors.CorsOptions.AllowAll);
config.EnsureInitialized();
map.UseWebApi(config);
}
private HttpConfiguration CreateTypedConfiguration<TBaseController>() where TBaseController : IHttpController
{
var config = new HttpConfiguration();
config.Services.Replace(typeof(IHttpControllerTypeResolver), new
TypedHttpControllerTypeResolver<TBaseController>());
config.EnableSwagger();
config.MapHttpAttributeRoutes(new TypedDirectRouteProvider<TBaseController>());
return config;
}
}
SwaggerExtensions.cs
public static class SwaggerExtensions
{
public static HttpConfiguration EnableSwagger(this HttpConfiguration httpConfiguration)
{
httpConfiguration
.EnableSwagger(c => c.SingleApiVersion("v1", "MyWebAPI"))
.EnableSwaggerUi();
return httpConfiguration;
}
}
MyController.cs
public class MyController : BaseApiController
{
[AllowAnonymous]
[HttpGet]
[Route("orders/{orderId}")]
public IHttpActionResult GetOrder([FromUri]string orderId) {
return Ok();
}
}
BaseApiController.cs
public class BaseApiController : ApiController { }
正如@Dai 所建议的那样,实际上是 https://localhost:5001/api/swagger
,它不起作用的原因是方法 ConfigureAutofac(config, map)
中的自定义 MessageHandlers
(未在代码中显示OP) 没有处理带有 /swagger
路径的请求。
MessageHandler
方法里面的代码ConfigureAutofac(config, map)
省略:
private void ConfigureAutofac(HttpConfiguration config, IAppBuilder app)
{
var builder = new ContainerBuilder();
//code omitted for brevity ...
//Register Web API controllers.
builder.RegisterApiControllers(Assembly.GetExecutingAssembly())
.InstancePerRequest();
//Register the Autofac filter provider.
builder.RegisterWebApiFilterProvider(config);
//Register the Autofac model binder provider.
builder.RegisterWebApiModelBinderProvider();
//code omitted for brevity ...
var container = builder.Build();
//Set the dependency resolver to be Autofac.
config.DependencyResolver = new AutofacWebApiDependencyResolver(container);
config.MessageHandlers.Insert(0, new ApiDelegatingHandler());
config.MessageHandlers.Insert(1, new ActivityLogHandler());
app.UseAutofacMiddleware(container);
app.UseAutofacWebApi(config);
}
自定义 MessageHandler
中唯一需要更改的是处理此问题,如下所示:
public class ApiDelegatingHandler : DelegatingHandler
{
protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
if (request.RequestUri.PathAndQuery.Contains("/swagger"))
return await base.SendAsync(request, cancellationToken);
//code omitted for brevity ...
}
}
我在 Web API 的 OWIN startup.cs 文件中实现了 Swagger,但是当我尝试打开 Swagger UI 页面时,它显示 HTTP 错误404.0 - 未找到
URL 检查 Swagger UI: https://localhost:5001/swagger
这是我的实现,请帮我解决我遗漏的问题。
Startup.cs
public class Startup
{
public void Configuration(IAppBuilder app)
{
app.Map("/api", map => { ConfigureApiArea(map); });
}
private void ConfigureApiArea(IAppBuilder map)
{
var config = CreateTypedConfiguration<BaseApiController>();
//Json Settings
JsonFormatterSettings(config);
ConfigureAutofac(config, map);
ConfigureOAuth(map);
config.EnableCors(new EnableCorsAttribute("*", "*", "*", "Paging-Headers,X-Error"));
map.UseCors(Microsoft.Owin.Cors.CorsOptions.AllowAll);
config.EnsureInitialized();
map.UseWebApi(config);
}
private HttpConfiguration CreateTypedConfiguration<TBaseController>() where TBaseController : IHttpController
{
var config = new HttpConfiguration();
config.Services.Replace(typeof(IHttpControllerTypeResolver), new
TypedHttpControllerTypeResolver<TBaseController>());
config.EnableSwagger();
config.MapHttpAttributeRoutes(new TypedDirectRouteProvider<TBaseController>());
return config;
}
}
SwaggerExtensions.cs
public static class SwaggerExtensions
{
public static HttpConfiguration EnableSwagger(this HttpConfiguration httpConfiguration)
{
httpConfiguration
.EnableSwagger(c => c.SingleApiVersion("v1", "MyWebAPI"))
.EnableSwaggerUi();
return httpConfiguration;
}
}
MyController.cs
public class MyController : BaseApiController
{
[AllowAnonymous]
[HttpGet]
[Route("orders/{orderId}")]
public IHttpActionResult GetOrder([FromUri]string orderId) {
return Ok();
}
}
BaseApiController.cs
public class BaseApiController : ApiController { }
正如@Dai 所建议的那样,实际上是 https://localhost:5001/api/swagger
,它不起作用的原因是方法 ConfigureAutofac(config, map)
中的自定义 MessageHandlers
(未在代码中显示OP) 没有处理带有 /swagger
路径的请求。
MessageHandler
方法里面的代码ConfigureAutofac(config, map)
省略:
private void ConfigureAutofac(HttpConfiguration config, IAppBuilder app)
{
var builder = new ContainerBuilder();
//code omitted for brevity ...
//Register Web API controllers.
builder.RegisterApiControllers(Assembly.GetExecutingAssembly())
.InstancePerRequest();
//Register the Autofac filter provider.
builder.RegisterWebApiFilterProvider(config);
//Register the Autofac model binder provider.
builder.RegisterWebApiModelBinderProvider();
//code omitted for brevity ...
var container = builder.Build();
//Set the dependency resolver to be Autofac.
config.DependencyResolver = new AutofacWebApiDependencyResolver(container);
config.MessageHandlers.Insert(0, new ApiDelegatingHandler());
config.MessageHandlers.Insert(1, new ActivityLogHandler());
app.UseAutofacMiddleware(container);
app.UseAutofacWebApi(config);
}
自定义 MessageHandler
中唯一需要更改的是处理此问题,如下所示:
public class ApiDelegatingHandler : DelegatingHandler
{
protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage request, CancellationToken cancellationToken)
{
if (request.RequestUri.PathAndQuery.Contains("/swagger"))
return await base.SendAsync(request, cancellationToken);
//code omitted for brevity ...
}
}