.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);
            });

  

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM