利用swagger建立互動式API文件

2015年12月28日 星期一

最近在寫Web API程式,通常都會搭配Help Page來使用,可以建立文件方便查詢,但是如果要測試API,則都會使用Fiddle或是PostMan來做測試,同事有介紹我一套叫Swagger的套件,它不只能產生文件,也可以在網頁上直接測試,是不是超棒的,以下是記錄我安裝的過程以及使用方法,我是用新專案來做範例


1.建立新專案
2.選擇Web API
3.使用NuGet來下載Swagger套件


4.安裝完成後,在專案上按右鍵,選擇屬性

5.選擇產生文件要放置的地方

6.開啟App_Start\SwaggerConfig.cs,打開註解處

7.實作GetXmlCommentsPath()方法

8.測試時,只要執行網站並在後面輸入\swagger即可開始頁面

9.可直接展開方法,並做測試,執行後可看到結果





以上就是基本的swagger套件使用方式。
最後附近github位址:https://github.com/domaindrivendev/Swashbuckle

0 意見: