.Net Core 项目引用Swagger应用

前言

 初步构造项目的时候，需要提前先将swagger配置好这样，后期我们无论写了啥接口
 都可以是可以通过swagger进行查看的。方便其他技术人员的接入，以及前端人员的
 对接。

配置过程

1.Net Core 项目的创建我这边不做讲解，网上有很多教程信息，可以自己看一下，我
觉得身为技术人员这样基础的事情，我应该可以省略，今天着重还是要讲一下配置信息
2.我们知道 Net Core项目的加载方式改变了，在我个人的理解中是认为采用了控制器
启动的方式，不在像之前那样方便了但是使用起来会更灵活了。
这里面有个非常重要的文件 Startup.cs 这个文件是我们用来添加对应的功能需要
进行使用的
3.首先引用 Nuget包 对应的有两个
Swashbuckle.AspNetCore程序包 （实现swagger功能需要）
Microsoft.Extensions.PlatformAbstractions 程序包 （添加注释需要 仅上面一个不会显示注释）
4.引用之后我们开始进行配置

//Startup.cs  类中处理

 		public void ConfigureServices(IServiceCollection services)
        {
            //添加控制器
            services.AddControllers();
			//这个地方可以添加很多   比如 session,视图控制器等，需要啥注册啥


            //配置Swagger
            //注册Swagger生成器，定义一个Swagger 文档
            services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
                //这个地方是配置swagger注释的地方
                var basePath = PlatformServices.Default.Application.ApplicationBasePath;
                //API.xml是我的项目生成XML文档的后缀名,具体的以你项目为主
                var xmlPath = Path.Combine(basePath, "API.xml");
                c.IncludeXmlComments(xmlPath);
            });

        }

 		public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            //路由
            app.UseRouting();
            //校验
            app.UseAuthorization();
            
            //--begin--swagger 配置信息    这个是重点，其他的看需要配置
            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });
 			//--end--
            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllers();
            });
        }
 

注意：需要调整属性生成中的输入 如下所示：

展示效果

文章参考：.Net Core3.1下使用Swagger搭建web api项目
微软官方介绍