1. 程式人生 > >【轉】WebApi 整合 Swagger

【轉】WebApi 整合 Swagger

1. Swagger(俗稱:絲襪哥)是什麼東西?

    Swagger 是一個規範和完整的框架,用於生成、描述、呼叫和視覺化 RESTful 風格的 Web 服務。總體目標是使客戶端和檔案系統作為伺服器以同樣的速度來更新。檔案的方法,引數和模型緊密整合到伺服器端的程式碼,允許API來始終保持同步。Swagger 讓部署管理和使用功能強大的API從未如此簡單。

2.絲襪哥可以幹什麼?

a.介面,服務視覺化,非常清晰,好用

b.做介面測試,方便測試人員使用

3.Swagger怎麼和WebApi整合?

第一步:建立WebApi工程

第二步:引入swagger的包(Swashbuckle、swagger兩個)

第三步:開啟解決方案屬性-->生成,勾選XML文件檔案,儲存

swagger在生成xml註釋文件之後會儲存到當前appdomaim下的bin目錄,用於在UI上展示

第四步:找到swaggerconfig檔案的註冊方法,去掉下面註釋的這一句程式碼,用於在UI上載入生成的xml文件

GetXmlCommentsPath方法的實現如下:讀取註釋檔案的路徑

private static string GetXmlCommentsPath()
        {
            return string.Format("{0}/bin/WebApiSwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory);
        }

第五步:開啟swggernet檔案,註釋掉下面的兩行程式碼(估計是nuget包中的程式碼沒有更新導致這個異常出現)

第六步:swagger已經整合成功了,在瀏覽器輸入:http://localhost:37033/swagger/ui/index 就可以看到介面了

補充:

按上述步驟完成後,會出現以下提示

解決方法是:

專案->屬性->生成->錯誤和警告(在“禁止顯示警告”中)輸入1591。