swagger使用二:swagger配置多個項目注釋


在項目中采用swagger測試接口,提供接口給其他人員都非常的方便.

在swagger默認配置中,默認只顯示接口訪問層中的注釋,可是很多的參數說明都已經在實體層中了啊?(如下圖)不可能再把實體層中的模型再搬過來吧,這樣子重復性也太大了.

經過一番摸索,發現swagger可以同時支持多個路徑的.

1.修改swagger的配置,添加多個文件路徑.        

    c.IncludeXmlComments(GetXmlControllersCommentsPath());
    c.IncludeXmlComments(GetXmlModelCommentsPath());

 

        private static string GetXmlControllersCommentsPath()
        {
            return System.IO.Path.Combine(System.Web.HttpRuntime.AppDomainAppPath, "./App_Data/WebApi.XML");
        }
        private static string GetXmlModelCommentsPath()
        {
            return System.IO.Path.Combine(System.Web.HttpRuntime.AppDomainAppPath, "./App_Data/Model.XML");
        }

2.修改實體層生成時,注釋文檔保存的位置,注意需要修改到接口訪問層中的路徑.

保存,重新生成,再訪問swagger。

可以顯示出實體層的注釋了,完畢。

 


免責聲明!

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



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