.Net Core 添加Swagger步驟

Startup.cs文件：

NuGet下載：Swashbuckle.AspNetCore

引入命名空間：

using Swashbuckle.AspNetCore.Swagger;

基本配置：

Startup.ConfigureServices方法添加：

//註冊Swagger生成器，定義一個和多個Swagger 文檔
services.AddSwaggerGen(c =>
{
     c.SwaggerDoc("v1", new Info { Title = "Vedm API V1", Version = "v1" });
});

Startup.Configure方法添加：

//啓用中間件服務生成Swagger作爲JSON終結點
app.UseSwagger();
//啓用中間件服務對swagger-ui，指定Swagger JSON終結點
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Vedm API V1");
});

啓用XML註釋：

右鍵單擊“解決方案資源管理器”中的項目，然後選擇“屬性”

查看“生成”選項卡的“輸出”部分下的“XML 文檔文件”框

Startup.ConfigureServices方法添加：

 services.AddSwaggerGen(options =>
            {
                options.SwaggerDoc("v1", new Info
                {
                    Version = "v1",
                    Title = "Vedm API V1"
                });
                // 爲 Swagger JSON and UI設置xml文檔註釋路徑
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程序所在目錄（絕對，不受工作目錄影響，建議採用此方法獲取路徑）
                var xmlPath = Path.Combine(basePath, "Lsxx.Vedm.App.xml");
                options.IncludeXmlComments(xmlPath);
            });

 

 

 

文章參考：

https://www.cnblogs.com/yilezhu/p/9241261.html

https://www.cnblogs.com/yanbigfeg/p/9232844.html