asp.net mvc 集成swagger

在ASP.NET MVC项目中集成Swagger需要几个步骤:

  1. 通过NuGet安装Swashbuckle包。

  2. 在项目的App_Start文件夹中配置Swagger。

  3. 定义API的XML注释。

  4. 配置Swagger以使用这些注释。

以下是一个基本的配置示例:

首先,通过NuGet安装Swashbuckle包:

bash 复制代码
Install-Package Swashbuckle

然后,在App_Start文件夹中添加一个SwaggerConfig.cs文件,并配置Swagger:

cs 复制代码
using System.Web.Http;
using WebActivatorEx;
using Swashbuckle.Application;
 
[assembly: PreApplicationStartMethod(typeof(YourProject.SwaggerConfig), "Register")]
 
namespace YourProject
{
    public class SwaggerConfig
    {
        public static void Register()
        {
            var thisAssembly = typeof(SwaggerConfig).Assembly;
 
            GlobalConfiguration.Configuration 
                .EnableSwagger(c =>
                    {
                        c.SingleApiVersion("v1", "My API");
                        
                        // 设置XML注释路径
                        var xmlFile = $"{typeof(SwaggerConfig).Assembly.GetName().Name}.xml";
                        var xmlPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, xmlFile);
                        c.IncludeXmlComments(xmlPath);
                    })
                .EnableSwaggerUi(c =>
                    {
                    });
        }
    }
}

确保项目属性中生成XML文档文件(通常在项目的Properties文件夹中的AssemblyInfo.cs文件中设置):

cs 复制代码
[assembly: XmlnsDefinition("http://schemas.datacontract.org/2004/07/YourProject.Models", "YourProject.Models")]
[assembly: Guid("YOUR-GUID-HERE")]
[assembly: AssemblyVersion("1.0.0.0")]
[assembly: AssemblyFileVersion("1.0.0.0")]
[assembly: AssemblyConfiguration("Release")]
[assembly: AssemblyDescription("My ASP.NET MVC Project")]
[assembly: AssemblyProduct("MyProduct")]
[assembly: AssemblyTitle("MyProject")]
[assembly: AssemblyCompany("MyCompany")]
[assembly: AssemblyCopyright("Copyright © MyCompany 2023")]
[assembly: ComVisible(false)]

最后,在Global.asax.cs文件中添加以下代码以启用Swagger:

cs 复制代码
protected void Application_Start()
{
    // ...其他启动代码...
    SwaggerConfig.Register();
}

完成这些步骤后,运行项目并导航到/swagger路径(例如:http://localhost:port/swagger),你应该能够看到Swagger UI界面。

相关推荐
哈哈很哈哈14 分钟前
Scala协变、逆变、上界/下界、隐式参数、隐式转换
开发语言·后端·scala
黄雄进16 分钟前
Spring Ioc —— 集合类型的依赖注入
java·后端·spring
小蒜学长30 分钟前
基于Hadoop的可视化城市宜居指数分析(代码+数据库+LW)
java·大数据·数据库·hadoop·spring boot·后端
向上的车轮1 小时前
Spring Boot 常用注解有哪些?
java·spring boot·后端
忧郁的蛋~1 小时前
在.NET标准库中进行数据验证的方法
后端·c#·asp.net·.net·.netcore
颜如玉2 小时前
谈谈SerializedLambda
java·后端·源码
Joey_Chen2 小时前
【Golang开发】Gin框架学习笔记——服务器的运行机制
后端·go
雨绸缪2 小时前
Excel上传失败,在剪切板有大量信息。是否保存其内容...
后端
二闹2 小时前
Python中那个看似神秘的if __name__ == __main__,一次给你讲明白
后端·python
用户8356290780512 小时前
C# 转换 Word 文档为图片:解锁文档处理的新维度
后端·c#