在ASP.Net Core中使用Swagger时,如果需要为Swagger 2.0显式绑定HttpMethod,可以通过使用Swagger的OperationFilter来实现。
首先,需要在Startup.cs文件中添加Swagger服务的配置。在ConfigureServices方法中,添加以下代码:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
});
然后,在Configure方法中启用Swagger中间件:
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
});
接下来,创建一个实现了IOperationFilter接口的类,用于显式绑定HttpMethod。在该类中,可以根据需要对特定的操作进行HttpMethod绑定。
using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen;
using System.Linq;
public class HttpMethodOperationFilter : IOperationFilter
{
public void Apply(OpenApiOperation operation, OperationFilterContext context)
{
var httpMethodAttributes = context.MethodInfo.GetCustomAttributes(true)
.OfType()
.ToList();
if (httpMethodAttributes.Any())
{
operation.Responses.Clear();
operation.OperationId = httpMethodAttributes.First().Name;
var attribute = httpMethodAttributes.First();
operation.Responses.Add(((int)attribute.StatusCode).ToString(), new OpenApiResponse { Description = attribute.Description });
}
}
}
最后,在Startup.cs文件的ConfigureServices方法中,注册HttpMethodOperationFilter:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
c.OperationFilter();
});
现在,当你在控制器的操作方法上使用HttpMethodAttribute时,Swagger将根据该属性的值为操作设置正确的HttpMethod。
[ApiController]
public class MyController : ControllerBase
{
[HttpGet("/api/my")]
[HttpMethod(Name = "GetMyData", StatusCode = HttpStatusCode.OK, Description = "Get my data")]
public IActionResult Get()
{
// ...
}
}
通过上述配置和代码示例,你可以在ASP.Net Core项目中使用Swagger,并显式绑定操作的HttpMethod。
上一篇:ASP.NET Core + Redis + nginx 的 Session id 总是在变化。
下一篇:ASP.NET Core + Swagger\SwashBuckle UI使用ADFS WS-federation进行登录