如何使用webapi整合swagger

2022-02-21 05:07:38 字數 1802 閱讀 6627

現在b/s開發中,前後端分離無疑已經成為一種新的時尚,但是如何把後端開發的介面更好的提供給前段開發呢?還用介面文件?low了吧。不僅要花時間開發介面,還得花時間寫文件,白花花的時間不久浪費了嗎。如果介面需要調整,還得改文件,這效率不用說了,肯定夠嗆。今兒思明和大家分享一篇視覺化webapi介面開發,就是去整合swagger。

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

下面介紹一下具體實現過程:

1、新建乙個專案aps.net web 應用程式

2、選擇 empty-->核心引用選擇 mvc和web api

3、選擇新建的專案右擊,在選單中選擇nuget程式包 左側選擇聯機,右側輸入框輸入swagger

選擇其中的 swashbuckle 和swagger ui for .net兩個安裝

4、右擊專案選擇選單屬性 --> 選擇生成 --> 選擇輸出xml文件檔案,並輸入不帶多餘.的檔名

6、刪除多餘無用的項

7、在資料夾controllers中新建乙個 web api 控制器類

8、直接執行。http://localhost:16650/swagger/ui/index 結果如下:

9、有些人不想直接執行vs就可以自動跳轉到 http://localhost:16650/swagger/ui/index 。也是可以的;如下:

在控制器中新增乙個控制器 homecontroller

using system.web.mvc;

namespace selfswaggerapi.controllers}}

然後直接執行。。就是見證奇蹟的時刻。

備註:常見問題

未能載入檔案或程式集「system.web.http, version=4.0.0.0, culture=neutral, publickeytoken=31bf3856ad364e35」或它的某乙個

原因分析:程式所依賴的dll 和實際引用的dll不相符,可以用修改配置檔案web.config的方式實現相容

SpringBoot如何優雅地使用Swagger2

spring boot 框架是目前非常流行的微服務框架,我們很多情況下使用它來提供 rest api。而對於 rest api 來說很重要的一部分內容就是文件,swagger 為我們提供了一套通過 和註解自動生成文件的方法,這一點對於保證 api 文件的及時性將有很大的幫助。本文將使用 swagge...

SpringBoot開發案例之整合Swagger篇

前段時間整合過的乙個支付服務,由於使用了spring boot快速開發,但是又懶得寫詳細的文件介紹,便順手就把swagger整合進來了,對支付服務進行分組api展示,如上圖。我有幾張阿里雲幸運券分享給你,用券購買或者公升級阿里雲相應產品會有特惠驚喜哦!把想要買的產品的幸運券都領走吧!快下手,馬上就要...

SpringBoot開發案例之整合Swagger篇

前段時間整合過的乙個支付服務,由於使用了spring boot快速開發,但是又懶得寫詳細的文件介紹,便順手就把swagger整合進來了,對支付服務進行分組api展示,如上圖。swagger 是乙個規範和完整的框架,用於生成 描述 呼叫和視覺化 restful 風格的 web 服務。總體目標是使客戶端...