在前後端開發中,前端開發人員往往會需要撰寫零零總總有關於後端資料介接的程式碼,本文介紹好用的工具【NSwag Studio】來幫助節省這段無意義且開發時期頻繁變更的工作。
前言
對於前端開發人員,專案(軟體)開發中往往會面對數次的後端資料格式調整,雖然可以用文件與格式向後端開發進行規範要求,但就實務上來說終究是不可行的,畢竟東西該改時還是要改。
而文件始終應該是開發過程的紀錄(共識)與提醒,因此善用工具面對這個多變的世界就是一個相當重要的課題了。
而現在就來介紹【NSwag Studio】這個工具,用來自動化產生提供swagger的後端的"介接程式碼"。
工具安裝
專案位置(https://github.com/RicoSuter/NSwag/wiki/NSwagStudio),進入後下載MSI安裝檔就可以開始進行安裝了。
安裝後找到這個小圖示就可以開始了。
開始實作
嘛....首先呢,要先有個API進行資料介接,為求簡單示範就快速設置一個預設的WebApi出來
接著便是開始施展魔法的時候了,
1.將swagger的API格式檔(JSON)設定到已經打開的Nswag中(Swagger Specification URL),並且按下Create local Copy,這樣就成功的完成第一步【後端格式範本下載】
2.按下Generate Outputs,就可以產生ClientCode了!(因為我在Outputs中勾選的是C#程式,因此這邊是輸出C#用的程式)
3.當然實務上不是用複製貼上去更新程式,太費工了。運用上是直接設定檔案輸出位置進行程式碼輸出。
4.呼叫看看
5.沒了,開始嘗試這個節省工時的工具吧!
備註
實務上這個工具配合版控可以發揮更強大的戰力,包含了設定檔的控管,與ClientCode的紀錄參照等。
而善用此工具便可讓開發更加的敏捷與彈性。也讓下班時間可以更加的靈活。