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

相关内容

热门资讯

前端-session、jwt 目录:   (1)session (2&#x...
linux入门---制作进度条 了解缓冲区 我们首先来看看下面的操作: 我们首先创建了一个文件并在这个文件里面添加了...
关于测试,我发现了哪些新大陆 关于测试 平常也只是听说过一些关于测试的术语,但并没有使用过测试工具。偶然看到编程老师...
前缀和与对数器与二分法 1. 前缀和 假设有一个数组,我们想大量频繁的去访问L到R这个区间的和,...
nodejs:本地安装nvm实... 一、背景-使用不同版本node的原因 vue3+ts、nuxt3版本,node...
JAVA集合知识整理 Java集合知识整理 HashMap相关 HashMap的底层数据结构:jdk1.8之...
无刷直流电机介绍及单片机控制实... 无刷直流电机介绍及单片机控制实例前言基本概念优势与劣势使用寿命基本结构使用单片机控制实例电子调速器&...
fwdiary(2) dp2 1.传纸条  AcWing 275. 传纸条 - AcWing 走两条路,走一条最大的...
常用的DOS命令 常用的DOS命令 DOS(Disk Operating System,磁...
<C++> 类和对象(下) 1.const成员函数将const修饰的“成员函数”称之为const成员函数,cons...