給WebAPI的REST介面服務新增測試頁面(一)

2021-09-06 23:16:00 字數 785 閱讀 3958

當使用webapi提供rest服務的時候,乙個經常進行的操作是對介面進行測試。asp.net webapi框架本身並沒有提供這一介面,不過由於提供的是標準的rest服務,是可以非常方便的使用一些第三方的工具的。

我之前經常用的chrome的postman外掛程式來進行測試,它可以用來模擬各種http請求操作。雖然這個工具也算好用,不過由於它只是乙個通用的工具,使用它的時候要構建http報文頭,並根據具體api組裝訊息體,這也是一件比較麻煩的事情。

今天網上閒逛的時候發現了乙個更加好用的測試工具swagger-ui,它專門針對rest介面提供了非常友好的測試介面:

不僅能提供介面列表,還能讀取介面的引數列表,提供友好的配置介面:

介面說明,引數說明,引數型別都能都都出來,非常友好,甚至連引數的各個欄位的注釋都能標記出來,基本上都是乙個非常友好的幫助文件了。

更多的示例可以參考它官方demo: 用它來進行測試非常簡單,直接輸入引數就行了,不用費力的構造各種url和報文,比postman方便多了。

由於篇幅所限,本文這裡就只對swagger-ui進行了一些簡單的介紹,下篇文章中再詳細介紹如何將swagger-ui整合到webapi中。

給WebAPI的REST介面新增測試頁面(三)

在前面的文章中,我介紹過了通過swashbuckle 在webapi 中整合swagger ui 不過這種方式不適合於最新版的 asp.net mvc6 下的webapi 在網上搜了一下,發現了它還有乙個專供 asp.net mvc6 webapi 使用的版本 新版本的使用也不複雜,首先在 proj...

給REST介面做鑑權認證 OAuth

本地儲存使用者名稱和密碼肯定是不合適的。參考了 如何設計好的restful api之安全性這裡寫鏈結內容 重新學習了oauth 發現原來oauth2.0還有四種模式可選 授權碼模式 authorization code 簡化模式 resource owner 密碼模式 password creden...

API介面 WebAPI的概念

webapi的概念 1.術語 介面 是某個物件和外界互動的部分 使用者介面ui user inte ce diameter,radius socket tcp 基於soap的web service http 訊息互動介面 程式設計介面,各種語言的開發包 其它介面 資料服務產品 sql語言操作介面 對...