多專案(multiple projects)時，會產生多個 xml document, 叫用 IncludeXmlComments 時記得要把每個專案的 xml document 都載入，才能顯示不同專案中的註解和說明 (comment)。

範例如下:

builder.Services.AddSwaggerGen(options =>

{

    options.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });



    //多個 Project, 每一個 xmldocument 都要載入

    List<string> xmlFiles = Directory.GetFiles(AppContext.BaseDirectory, "*.xml", SearchOption.TopDirectoryOnly).ToList();

    foreach (string fileName in xmlFiles)

    {

        string xmlFilePath = Path.Combine(AppContext.BaseDirectory, fileName);

        if (File.Exists(xmlFilePath))

            options.IncludeXmlComments(xmlFilePath, includeControllerXmlComments: true);

    }



    //防止 SchemaId 的錯誤

    options.CustomSchemaIds(type => type.ToString());

}); 

這些都可以從註解中讀取:


 
 

 

 
在註冊Swagger時如圖中
1. 將各自action名稱代用不同編碼，避免名稱相撞導致swagger不能正確辨識。
2. 將專案XML輸出改為專案名稱($(AssemblyName))供註冊時指定反射用
↓ (對專案點擊右鍵 => 屬性 => 生成(Build) => 輸出(Output) => XML 文件名稱(XML documentation file path))