給WebAPI的REST接口服務添加測試頁面(一)


當使用WebAPI提供REST服務的時候,一個經常進行的操作是對接口進行測試。Asp.net WebAPI框架本身並沒有提供這一接口,不過由於提供的是標准的REST服務,是可以非常方便的使用一些第三方的工具的。

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

今天網上閑逛的時候發現了一個更加好用的測試工具Swagger-UI,它專門針對REST接口提供了非常友好的測試界面:

不僅能提供接口列表,還能讀取接口的參數列表,提供友好的配置接口:

接口說明,參數說明,參數類型都能都都出來,非常友好,甚至連參數的各個字段的注釋都能標記出來,基本上都是一個非常友好的幫助文檔了。

更多的示例可以參考它官方Demo:http://petstore.swagger.io/。 用它來進行測試非常簡單,直接輸入參數就行了,不用費力的構造各種URL和報文,比Postman方便多了。

由於篇幅所限,本文這里就只對Swagger-UI進行了一些簡單的介紹,下篇文章中再詳細介紹如何將Swagger-UI集成到WebAPI中。


免責聲明!

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



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