一、簡介：為了更好的管理和測試我們的介面，我這裡使用了Swagger框架。Swagger是什麼？Swagger 是一個規範和完整的框架，用於生成、描述、呼叫和視覺化RESTful風格的 Web 服務。

二、安裝Get包

Swashbuckle.AspNetCore

三、開啟Startup.cs檔案，引用名稱空間

using System.IO;
using System.Reflection;
using Swashbuckle.AspNetCore.Swagger;

四、在ConfigureServices方法里加入下面的程式碼，註冊Swagger生成器，定義一個文件，設定xml文件的註釋路徑，。

//配置Swagger
//註冊Swagger生成器，定義一個Swagger 文件
services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new Microsoft.OpenApi.Models.OpenApiInfo()
    {
        Version = "v1",
        Title = "介面文件",
        Description = "RESTful API"
    });
    // 為 Swagger 設定xml文件註釋路徑
    var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml
 
";
    var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
    c.IncludeXmlComments(xmlPath);
});

五、在Configure方法里加入下面的程式碼，啟用中介軟體服務使用生成Swagger和SwaggerUI，將SwaggerUI中的RoutePrefix設為空字串，這樣就能在根節點（http://localhost:port）直接顯示SwaggerUI介面。

//啟用中介軟體服務生成Swagger
app.UseSwagger();
//啟用中介軟體服務生成SwaggerUI，指定Swagger JSON終結點
 

app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "Web App V1");
    c.RoutePrefix = string.Empty;//設定根節點訪問
});

六、設定生成的xml檔案

1.開啟專案屬性

2、點開生成頁面：配置輸出路徑和XML文件檔案

3.開啟除錯頁面：啟動瀏覽器配置的路徑為空