ASP.Net Core + Swagger - 操作需要为Swagger 2.0显式绑定HttpMethod
创始人
2024-09-14 11:01:22
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。

相关内容

热门资讯

安装apache-beam==... 出现此错误可能是因为用户的Python版本太低,而apache-beam==2.34.0需要更高的P...
避免在粘贴双引号时向VS 20... 在粘贴双引号时向VS 2022添加反斜杠的问题通常是由于编辑器的自动转义功能引起的。为了避免这个问题...
Android Recycle... 要在Android RecyclerView中实现滑动卡片效果,可以按照以下步骤进行操作:首先,在项...
安装了Anaconda之后找不... 在安装Anaconda后,如果找不到Jupyter Notebook,可以尝试以下解决方法:检查环境...
omi系统和安卓系统哪个好,揭... OMI系统和安卓系统哪个好?这个问题就像是在问“苹果和橘子哪个更甜”,每个人都有自己的答案。今天,我...
原生ios和安卓系统,原生对比... 亲爱的读者们,你是否曾好奇过,为什么你的iPhone和安卓手机在操作体验上有着天壤之别?今天,就让我...
Android - 无法确定任... 这个错误通常发生在Android项目中,表示编译Debug版本的Java代码时出现了依赖关系问题。下...
Android - NDK 预... 在Android NDK的构建过程中,LOCAL_SRC_FILES只能包含一个项目。如果需要在ND...
Akka生成Actor问题 在Akka框架中,可以使用ActorSystem对象生成Actor。但是,当我们在Actor类中尝试...
Agora-RTC-React... 出现这个错误原因是因为在 React 组件中使用,import AgoraRTC from “ago...