asp.Net项目中使用Swagger

---

一、引用NuGet包

请复制：Swashbuckle.AspNetCore

二、配置Swagger服务

//可以添加多个版本，请参考文档
//注册Swagger生成器，定义一个和多个Swagger 文档
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("V1", new OpenApiInfo
                {
                    Version = "V1版本号",
                    Title = "标题",
                    Description = "说明：.net core 3.1-web API",
                    Contact = new OpenApiContact
                    {
                        Name = "名称",
                        Email = "邮箱",
                    },
                    License = new OpenApiLicense
                    {
                        Name = "许可证",
                    }
                });
                // 为 Swagger JSON and UI设置xml文档注释路径
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录
                var xmlPath = Path.Combine(basePath, $"{typeof(Startup).Assembly.GetName().Name}.xml");
                c.IncludeXmlComments(xmlPath, true);
            });

三、 添加Swagger中间件

            //启用中间件服务生成swagger 作为JSON的终点
            app.UseSwagger();
            //启用中间件服务对swagger-ui，指定Swagger JSON终结点
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/V1/swagger.json", "护理系统API");
                //路由前缀省略则访问：http://localhost:5555/swagger/index.html
                //此处设置为空，则访问：http://localhost:5555/index.html
                c.RoutePrefix = string.Empty;
            });

到此运行项目已经可以看到Swagger的UI页面了。
为了更全面的看到接口注释需要继续走下去。

四、启动注释

开启XML文档文件，取消显示警告加入 1591; 即可

五、查看效果