WebAPI项目中使用Swagger

最近开始用一个工具Swagger，可以自动生成接口文档并测试接口，简直太好用了，可以告别PostMan，并且也不用写接口文档了，强烈推荐！！！

首先声明一下，这个是针对WebApi的，继承Controller是控制器是不支持的哦。

1、在NuGet里面搜索Swashbuckle.AspNetCore包进行安装

 2、在Startup类添加相关内容

 ConfigureServices方法里面注入服务，全局添加了Authorize

            services.AddSwaggerGen(c =>
            {
                // Bearer 的scheme定义
                var securityScheme = new OpenApiSecurityScheme()
                {
                    Description = "JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"",
                    Name = "Authorization",
                    //参数添加在头部
                    In = ParameterLocation.Header,
                    //使用Authorize头部
                    Type = SecuritySchemeType.Http,
                    //内容为以 bearer开头
                    Scheme = "bearer",
                    BearerFormat = "JWT"
                };

                //把所有方法配置为增加bearer头部信息
                var securityRequirement = new OpenApiSecurityRequirement
                {
                    {
                            new OpenApiSecurityScheme
                            {
                                Reference = new OpenApiReference
                                {
                                    Type = ReferenceType.SecurityScheme,
                                    Id = "bearerAuth"
                                }
                            },
                            new string[] {}
                    }
                };

                //注册到swagger中
                c.AddSecurityDefinition("bearerAuth", securityScheme);
                c.AddSecurityRequirement(securityRequirement);
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath);
            });

在Configure方法里面添加中间件

            app.UseSwagger();
            app.UseSwaggerUI(c =>
            {
                c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                c.RoutePrefix = string.Empty;
            });

3、设置：选择项目点击右键-》属性=》生成=》勾选输出下面的XML文档文件的对勾

 4、接口需要按照规范写注释，最终结果如下：