在WebApi中 整合 Swagger

2021-09-07 07:22:32 字數 2514 閱讀 4706

1. swagger(俗稱:**哥)是什麼東西?

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

2.**哥可以幹什麼?

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

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

3.swagger怎麼和webapi整合?

第一步:建立webapi工程

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

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

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

getxmlcommentspath方法的實現如下:讀取注釋檔案的路徑

1

2

3

4

privatestaticstringgetxmlcommentspath()

/bin/webapiswaggerdemo.xml"

}

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

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

第七步:開發自己的api模組

1

2

3

4

5

6

7

8

9

10

///

/// 更新訂單資訊

指定路由位址  order/updateorder  和訪問方式 post/get/put

第八步:測試呼叫

通過swaggerui可以通過你的comtroller來分模組瀏覽和測試介面列表

這對於公司內部使用太方便了,所有的api 可以供開發和測試來呼叫,但是需要注意的一點是,生產環境還是要做許可權控制的,因為post和put方法是可以直接運算元據庫的。

公司一直在用,但是沒時間總結和分享,最近寫下來希望對大家有幫助。

在Visual C 中整合DDK WDK

要在windows下開發驅動程式,最直接的方法就是用免費的wdk windows driver kit 但是wdk只提供了命令列下執行的編譯和鏈結工具,並沒有ide,這樣對於那些用貫了visual c 的開發者會來說有些不方便。要把wdk整合到visual c 裡,要對專案進行如下設定 1 新建乙個...

在SpringBoot中整合Redis

科技優家 2017 01 16 17 17 上篇介紹了 spring data jpa一些使用方法,都是基於mysql資料庫來講解的,但是在實際專案中,由於訪問量的不斷增大,資料庫的壓力會越來越大,這時候類似於mysql的資料庫往往只是為了兜底或者在降級時才會有查詢操作,大部分的讀操作都會集中在快取...

在springboot中整合bootstrap

比較簡單,不要想的太複雜了。首先匯入依賴bootstrap與jquery org.webjars bootstrap 3.3.5 org.webjars jquery 3.1.1 然後在html檔案中加入相應版本 btn 類是按鈕的基本樣式 基本按鈕 關鍵的三句 專案結構圖 然後就可以了。不要在po...