.netcore3.1添加swagger

先打開netcore官網查看swagger接入文檔，路徑：netcore官網

那就跟着官網一步一步來吧

首先建立一個.netcore3.1的webapi，這個就不演示了。

從官網上可以看到最簡單的引入swaager的步驟如下：

1、引入最新版的swaager

Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4

2、在startup類中的ConfigureServices 方法中的服務集合中添加如下代碼

// Register the Swagger generator, defining 1 or more Swagger documents
    services.AddSwaggerGen(c =>
    {
        c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
    });

3、 在startup類中的Configure 方法中啟用中間件為生成的 JSON 文檔和 Swagger UI 提供服務

 // 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");
    });

4、運行項目並在瀏覽器訪問swaager/index.html,結果如下：

 

 

 5、swagger顯示xml注釋

5.1給接口加一個注釋

        /// <summary>
        /// 獲取天氣預報（get）
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public IEnumerable<WeatherForecast> Get()

5.2右鍵點擊項目---->屬性------>生成------>勾選xml文檔文件

 

 5.3在startup類中的ConfigureServices 方法中的服務集合中添加如下代碼

 //注冊swagger 
            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表示顯示控制器注釋）
           
            });

5.4運行項目並訪問swaggerUI

 

6、生成swaggerUI 規范，直接訪問如下鏈接，會自動生成一個swagger.json的json文件。

swagger/v1/swagger.json