iT邦幫忙

2023 iThome 鐵人賽

DAY 7
0

前言

欸~沒錯今天還是要再來講個測試API的工具。(眾人:阿就測個API你是要用多少工具啦)好啦我的測API工具箱也快被掏空了xD反正工具永遠不嫌多嘛
會知道Swagger是因為之前上課聽助教分享過,但後來在工作上因為現有專案沒有特別做設定,所以我也沒有特別再繼續使用。工具有很多種,沒有最好的只有適合的。之前看到的資料蠻多都是用前端來建立,今天的介紹會站在後端。使用的框架是.net core 6。

Swagger是什麼

Swagger是一個套件,可以讓API的回傳更視覺化、更好閱讀。以後端來說如果有多個Controller的話,就會有自動幫你分成多個區塊,像是下圖有Customer和Order這兩個Controller。這樣就可以一目了然去找想要找的API了
https://ithelp.ithome.com.tw/upload/images/20230921/20162714R0djCpp9Ri.png

好處與壞處

好處

  • 不用特地再額外花時間寫API文件,只要API建好文件也跟著產好了
  • 視覺化、有一些色彩就是好看R
  • 前端朋友只要一看就知道要送什麼參數以及要怎麼串接API欄位
  • 如果想要.json檔案或cURL也都會直接幫你產好可以直接複製
    https://ithelp.ithome.com.tw/upload/images/20230921/20162714RnfiAn1Dif.png

壞處

  • 如果API太多其實閱讀性不太好,像今天的範例只有兩個controller就還好。如果像是公司專案規模比較大的,一個專案裡面基本上是100支API起跳,那頁面就會有很多資訊

小結

本來想繼續講設定步驟但覺得篇幅太長了,所以大家明天見~可以建個練習專案來玩看看這個小工具
文章同步發布於:https://tw.coderbridge.com/@hsiaovicky567/7a22f5aed9db4cb5914413a0ca2bc262


上一篇
[Day6]不可不知的小工具-REST Client
下一篇
[Day8]不可不知的小工具-Swagger-2
系列文
懶還要更懶,快還要更快。不可不知的小工具和知識30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言