asp .net core Api Swagger集成配置项目
1,创建 asp .net core 3.1 Api Swagger项目
2,添加程序包,通过命令的方式进行添加如下:
在 工具->NuGet 包管理器->程序包管理器控制台 进行单击进去,能后在再控制台中输入命令
执行以下命令
Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4
3,添加 并配置Swagger中间件
3.1 在startup类中的ConfigureServices
方法中的服务集合中添加如下代码
services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" }); });
3.2 在startup类中的Configure
方法中启用中间件为生成的 JSON 文档和 Swagger UI 提供服务
app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });
4,如果对接口做了xml注释,要在Startup添加如下代码,才可以显示出来
先引入NuGet包:Microsoft.Extensions.PlatformAbstractions
然后右键属性
再在Startup中添加下面的代码
services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" }); var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml"; var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile); c.IncludeXmlComments(xmlPath, true); //添加控制器层注释(true表示显示控制器注释) });
项目需要配置一下勾上xml复选框要不能会报错:
右边单击 项目->选择属性->再选择生成->勾选xml复选框
5,在launchSettings.json中更改一下launchUrl这个环境变量,这样就不用每次都改地址栏了