.NET CORE 使用Swagger

NuGet集成Swashbuckle.AspNetCore：启用XML注释展示API文档

原创已于 2023-01-10 14:50:04 修改 · 1.1k 阅读

1 ·

CC 4.0 BY-SA版权

文章标签：

#.netcore

于 2021-10-23 11:26:22 首次发布

Asp.Net Core 专栏收录该内容

12 篇文章

订阅专栏

本文介绍如何使用NuGet为项目安装Swashbuckle.AspNetCore，并在Startup中配置服务和注册中间件，实现API接口注释显示。通过调整SwaggerGen设置，包括XML文件的包含和控制器注释的显示，确保API文档完整。

NuGet给项目安装包文件Swashbuckle.AspNetCore

在Starup中注入服务和注册中间件
配置以上条件后运行项目然后在地址栏输入https://localhost:44381/swagger/index.html

得到以下运行效果，看到以下图片不是很满意，跟博客大佬的不是相同，没有接口注释

4. 启用xml

在修改

 //注册swagger服务
            services.AddSwaggerGen(s =>
            {
                s.SwaggerDoc("v1", new OpenApiInfo { Title = "XC API", Version = "v1" });
                // 获取xml文件名
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                // 获取xml文件路径
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                // 添加控制器层注释，true表示显示控制器注释
                s.IncludeXmlComments(xmlPath, true);
            });