.netcore3.1新增Swagger
阿新 • • 發佈:2020-08-10
- 右鍵專案->屬性->Nuget包管理 新增Swashbuckle.AspNetCore引用
- 新增服務注入
public void ConfigureServices(IServiceCollection services) { services.AddControllers(); services.AddSwaggerGen(c => { c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1"}); }); }
- 新增中介軟體,然後在瀏覽器中輸入地址:https://localhost:****/swagger/index.html
// Enable middleware to serve generated Swagger as a JSON endpoint. app.UseSwagger(); // Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), // specifying the Swagger JSON endpoint.app.UseSwaggerUI(c => { c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1"); });
- 配置XML在介面中顯示註釋,選中如圖XML複選框
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表示顯示控制器註釋) });