【NSwag Studio】應用-實際開始導入開發吧

 開始使用NSwag產生Client端程式碼是一回事,而如何運用到專案開發中又是另一回事。本文將介紹基礎的導入專案環節技巧。

前言

  雖然NSwag可以快速的產生呼叫後端API的程式碼,但若是每一個前端程式開發時都要自己產生一份,難免違反共用原則,往後更新時也會零零落落,殘破不堪,苦了維護人員。因此運用上,這些Client Code會統一整理成一個專案來存放與擴充。

開始實作

1.首先,Nswag的設定是可以儲存的。因此運用上的第一步就是將設定檔一起放入【專門用來管理這些Client Code的專案】,完成後就可以將設定檔一起嵌入版控中控管了。

2.針對設定檔記得要調整命名空間,使其跟專案一致

3.處理好Nswag設定並重新建立程式後在Client端的專案設定專案引用。調整好後的Api Client呼叫就慢慢開始感覺出重複運用的感覺了。

4.實務上,一個Api Client的呼叫器於一個程式只會出現一個,因此還要針對Client端的專案進行變數呼叫抽出作業。

5.整理之後的呼叫方式大抵上就會變成這樣,而大抵上之後的開發中,使用API與其行為的方式就會變得比較像這樣簡單明瞭(當然加上需求行為的處理程式後就會開始面生了....)。

備註

 實務上當然不會那麼簡單,開發人員的惰性是無限大的,要是能夠不用上班就有薪水拿多好之類。因此後面還會接著繼續介紹有關於錯誤捕捉設定處理與更進階的設定方式。(例如用環境變數處理處理那個BaseUrl)

 

延伸閱讀

You're using HttpClient wrong and it is destabilizing your software