Net core配置swagger
实现步骤
1,创建ASP.NET Web API应用程序
2,安装Nuget包:Swashbuckle.SwaggerGen
3,修改Startup.cs文件
- 双击打开Startup.cs文件
- 在ConfigureServices方法中,加入以下代码,以增加对Swagger的支持
1 #region Swagger 2 services.AddSwaggerGen(c => 3 { 4 c.SwaggerDoc("v1", new OpenApiInfo 5 { 6 Version = "v1", 7 Title = "皮卡丘的十万伏特", 8 Description = "A simple example ASP.NET Core Web API", 9 TermsOfService = new Uri("https://example.com/terms"), 10 Contact = new OpenApiContact 11 { 12 Name = "Shayne Boyer", 13 Email = string.Empty, 14 Url = new Uri("https://twitter.com/spboyer"), 15 }, 16 License = new OpenApiLicense 17 { 18 Name = "Use under LICX", 19 Url = new Uri("https://example.com/license"), 20 } 21 }); 22 23 var basePath = PlatformServices.Default.Application.ApplicationBasePath; 24 //Restful.Web.Api.xml是我的项目生成XML文档的后缀名,具体的以你项目为主 25 var xmlPath = Path.Combine(basePath, "Restful_Api_Dome.xml");26 c.IncludeXmlComments(xmlPath); 27 }); 28 #endregion
3.在Configure方法中,加入以下代码
1 app.UseSwagger(); 2 app.UseSwaggerUI(c => 3 { 4 c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); 5 });
4,修改xml路径

5,修改项目启动路径

6,然后F5执行

7,打开ValuesController.cs文件,增加一些注释

执行看下

这样就可以通过Swagger进行调试接口咯

浙公网安备 33010602011771号