.net framework 4.5 asp.net api 使用 swagger


之前是在.net core api 中使用了 swagger,但是今天公司這邊要做IM,需要一個api項目,考慮到同事對.net core 還不算太熟悉而且時間進任務重,所以還是用了 asp.net

1、創建一個api項目

我這邊的環境是 vs2019 .net framework 4.5 api2+

2、NuGet引入包

  swashbuckle  swagger.net.ui

3、配置swagger

先再HomeController中創建一個action(測試用,主要是為了不迷路)

4         {
5             return Redirect("/swagger/ui/index");
6         }

然后設置xml注釋文檔路徑

再然后在app_start中找到SwaggerNet.cs文件,注釋掉這兩行

  到這里基本上就完事了,你運行下然后訪問  http://localhost:7438/Home/API 就能看到swagger了,但是接口方法是沒有注釋的,然后咱們把注釋顯示出來 ,找到app_start文件下的SwaggerConfig.cs文件

c.IncludeXmlComments(GetXmlCommentsPath());

找到這句代碼,解除注釋,這個時候會提示找不到GetXmlCommentsPath方法,這個方法如下,但是要注意下.xml文件地址,寫成自己的

1 private static string GetXmlCommentsPath()
2 {
3     return string.Format("{0}/bin/XXXXX.IM.API.xml", System.AppDomain.CurrentDomain.BaseDirectory);
4 }

接下來再次運行就可以啦,所有方法都能看到注釋了,其實還是有些問題,controller注釋無法顯示,JWT無法攜帶,不過時間倉促就暫時不研究了,后續如果用了在更新;

 

 

 

 

 


免責聲明!

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



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