1. 程式人生 > 實用技巧 >.net core api 整合swagger 文件不顯示action中文註釋、分層開發形參實體不顯示實體屬性註釋、返回值不顯示實體註釋問題

.net core api 整合swagger 文件不顯示action中文註釋、分層開發形參實體不顯示實體屬性註釋、返回值不顯示實體註釋問題

在類庫或者api專案上右鍵--屬性--生成--輸出--XML文件檔案上打√,

然後在Startup.cs中ConfigureServices新增如下配置即可:

 services.AddSwaggerGen(config =>
            {

                //var provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();
                config.SwaggerDoc("v1", new OpenApiInfo { Title = "CL.MEStoWMS.WebApi", Version = "v1" });

                // 為 Swagger JSON and UI設定xml文件註釋路徑
                var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//獲取應用程式所在目錄(絕對,不受工作目錄影響,建議採用此方法獲取路徑)
                var xmlPath = Path.Combine(basePath, "MEStoWMS.WebApi.xml");//介面action顯示註釋
                var xmlPath_entity = Path.Combine(basePath, "實體類庫.xml");//分層實體顯示註釋
                config.IncludeXmlComments(xmlPath);
                config.IncludeXmlComments(xmlPath_entity);
            });