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。

相关内容

热门资讯

开挂辅助插件"pok... 开挂辅助插件"pokermaster辅助器"开挂(透视)辅助插件(有挂总结) >>您好:软件加薇13...
开挂辅助平台"wep... 开挂辅助平台"wepoker代打辅助"开挂(透视)辅助工具(新版有挂)《详细加薇136704302咨...
开挂辅助平台"wep... 您好:这款wepoker怎么下载游戏游戏是可以开挂的,确实是有挂的,很多玩家在这款wepoker怎么...
开挂辅助安装"epo... 开挂辅助安装"epoker透视"开挂(透视)辅助下载(有挂攻略);无需打开直接搜索微信(136704...
开挂辅助神器"佛手大... 开挂辅助神器"佛手大菠萝有挂吗"开挂(透视)辅助平台(真实有挂)【无需打开直接搜索加薇1367043...
开挂辅助插件"约局吧... 开挂辅助插件"约局吧是否有挂"开挂(透视)辅助安装(有挂秘笈)>>您好:软件加136704302中薇...
开挂辅助工具"wep... 开挂辅助工具"wepoker透视脚本是什么"开挂(透视)辅助安装(果真有挂)您好:wepoker透视...
开挂辅助神器"约局吧... 约局吧app有挂吗开挂教程视频分享装挂详细步骤在当今的网络游戏中,约局吧app有挂吗作为一种经典的娱...
开挂辅助插件"wpk... 开挂辅助插件"wpk安卓下载辅助"开挂(透视)辅助平台(真是有挂)您好:wpk安卓下载辅助这款游戏可...
开挂辅助下载"wep... 开挂辅助下载"wepoker黑侠破解"开挂(透视)辅助安装(有挂助手);无需打开直接搜索加(薇:13...