Swagger

為API介面生成文件

Core中新增Swagger

1. nuget安裝包

install-package Swashbuckle.AspNetCore

2. 註冊服務

public void ConfigureServices(IServiceCollection services)
{
    services.AddControllersWithViews();

    
    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表示顯示控制器註釋）
    });
}

 

3. 使用服務

    // 啟用中介軟體為生成的 JSON 文件和 Swagger UI 提供服務
    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");
　　　　　//c.RoutePrefix = string.Empty; 
    });

 

4. 忽略XML註釋警告

右鍵專案屬性>生成>錯誤和警告新增 1591

原始碼