Swagger是最受欢迎的REST APIs文档生成工具之一,话不多说立即开始
1,在NuGet中搜索swagger,由于我使用的是.netcore3.1,所以选择Swashbuckle.AspNetCore安装即可
2,在Startup.cs文件中的ConfigureServices方法和Configure方法中添加以下代码
public void ConfigureServices(IServiceCollection services) { //添加Swagger服务 services.AddSwaggerGen(c => {
//添加文档信息 c.SwaggerDoc("v1", new OpenApiInfo { Title = "xxx.Api", Version = "v1" }); });
//...
}
public void Configure(IApplicationBuilder app, IWebHostEnvironment env) { // 使用Swagger中间件 app.UseSwagger(); // 配置SwaggerUI app.UseSwaggerUI(c => {
c.SwaggerEndpoint("/swagger/v1/swagger.json", "xxx.Api"); c.RoutePrefix = string.Empty; });
//... }
3,启动测试运行一下 http://localhost:5000/index.html