ASP.Net Core + Swagger - 操作需要为Swagger 2.0显式绑定HttpMethod
创始人
2024-09-14 11:00:30
0

在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。

相关内容

热门资讯

一分钟了解(wopoker)外... 一分钟了解(wopoker)外挂透明挂辅助软件(软件透明挂)一般真的有挂(2023已更新)(小红书)...
推荐十款(wepoke)外挂透... 推荐十款(wepoke)外挂透明挂辅助安装(智能ai代打)的确是有挂的(2020已更新)(百度)1、...
科普(WepokE)外挂透明挂... 科普(WepokE)外挂透明挂辅助插件(透视辅助)的确是有挂的(2025已更新)(头条)1、起透看视...
最新研发(wpK)外挂透明挂辅... 最新研发(wpK)外挂透明挂辅助工具(透视)就是真的有挂(2022已更新)(小红书)1、系统规律教程...
重大推荐(云扑克app)外挂透... 重大推荐(云扑克app)外挂透明挂辅助脚本(软件透明挂)总是真的有挂(2020已更新)(百度)辅助器...
必备科技(poker worl... 必备科技(poker world)外挂透明挂辅助器(透视辅助)都是真的有挂(2024已更新)(微博热...
重大推荐(we辅助poker)... 重大推荐(we辅助poker)外挂透明挂辅助脚本(透视辅助)一贯真的有挂(2023已更新)(百度)w...
一分钟了解(来玩德州)外挂透明... 一分钟了解(来玩德州)外挂透明挂辅助插件(透视辅助)原来真的有挂(2025已更新)(微博热搜)1、一...
一分钟了解(轰趴大菠萝)外挂透... 一分钟了解(轰趴大菠萝)外挂透明挂辅助安装(辅助挂)原来真的有挂(2022已更新)(知乎)1、每一步...
玩家必用(AAPOKEr)外挂... 玩家必用(AAPOKEr)外挂透明挂辅助工具(智能ai代打)果然真的有挂(2021已更新)(今日头条...