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界面。

相关推荐
调试人生的显微镜23 分钟前
Web 前端可视化开发工具深度解析,从拖拽搭建到真机调试的全链路思维
后端
调试人生的显微镜1 小时前
苹果商城上架全流程详解,从开发者账号到开心上架(Appuploader)跨平台上传的免 Mac 实战指南
后端
IT_陈寒1 小时前
React 18并发模式实战:3个优化技巧让你的应用性能提升50%
前端·人工智能·后端
@大迁世界1 小时前
我用 Rust 重写了一个 Java 微服务,然后丢了工作
java·开发语言·后端·微服务·rust
MeowRain1 小时前
G1新生代跨代引用
后端
沐怡旸1 小时前
【计算机通识】认识 RESTful API
后端·restful
青鱼入云1 小时前
介绍一下Ribbon
后端·spring cloud·ribbon
雾岛听风来1 小时前
Android开发中常用高效数据结构
前端·javascript·后端
IT_陈寒1 小时前
Vue 3性能优化实战:这5个Composition API技巧让你的应用快30%
前端·人工智能·后端
菜鸟的迷茫1 小时前
Feign 超时 + 重试引发雪崩:一次线上事故复盘
java·后端