基于.NET6平台开发WebApi（三）—— 添加Swagger支持

原创

已于 2022-03-02 14:12:06 修改 · 6.5k 阅读

收录于

当前文章被以下社区和专栏收录：

于 2022-01-10 13:41:34 首次发布

本文详细介绍如何在.NET 6项目中集成Swagger，包括配置Nuget包、启用XML文档、添加安全性定义及运行Swagger界面。

源码点我

本项目使用的一些框架如下：

Swagger，Serilog，Sqlugar，CSRedis，Autofac

具体配置将会在后续逐一介绍

1、首先我们对项目进行引用，右键.NET6.Api项目依赖项，选择添加项目引用，勾选NET6.Domain和NET6.Infrastructure，使用相同的方法为NET6.Infrastructure添加NET6.Domain引用。
在这里插入图片描述
2、打开Nuget，搜索安装Swashbuckle.AspNetCore。

3、由于swagger是基于xml文件来加载文档，所以我们要启用项目的xml，分别右键NET.Api和NET.Domain，选择属性，找到生成→输出，勾选生成包含Api文档的文件。

4、打开Program.cs，添加如下代码

var basePath = AppContext.BaseDirectory;

#region 添加swagger注释
builder.Services.AddSwaggerGen(c =>
{
   
   
    c.SwaggerDoc("v1", new OpenApiInfo
    {
   
   
        Version =