开发随笔记录——关于Swagger的安装与使用。
声明:本次使用的是ASP.NET Core 3.1版本
首先在NuGet程序包中安装Swashbuckle.AspNetCore程序包。
安装成功后,在Startup.cs文件里ConfigureServices方法下加入,如下代码:
// 添加Swagger services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "PracticeDemo.Api", Version = "v1" }); });
之后再在Configure方法下添加关于Swagger的中间件,如下代码:
// 添加Swagger有关中间件 app.UseSwagger(); app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "PracticeDemo.Api v1"); });
代码添加完毕后,在将要调试的控制器里面,每一个API都加入将要请求的方式,例如[HttpGet]、[HttpPost]等等,demo代码如下:
相关的代码添加完毕确认无误后,即可进行测试。在测试URL端口后面加入/swagger/Index.html。例如https://localhost:5001/swagger/index.html
这样就可以完成安装并且可以愉快的调试玩耍啦~~~