iT邦幫忙

2023 iThome 鐵人賽

DAY 5
2
影片教學

Node.js 實戰密技與辦公室的小壞壞:即戰力釋放讓總裁的心動瞬間系列 第 5

Node.js 文件產生器 Swagger | 別人家的後端都會產文件!?我們家的都... Day5

  • 分享至 

  • xImage
  •  

網路上 API 文件都那麼完整,為什麼我們公司的都...

什麼!?這次文件應該是我負責?誒,我還沒寫過文件啊~~~

Swagger 算是目前相當主流的 API 文件工具,雖然說是主流,但還是要花上不少時間規劃及撰寫,就以撰寫一段 API 文件來說,就會包含以下流程:

  • 列出需要撰寫的路由
  • 撰寫路由、請求 headers、body、資料格式...
  • 確認產出文件內容是否正確
  • 測試、驗證文檔
  • 部署上線

而在本篇影片中,將會介紹 Swagger Auto Gen 這個工具,可以大幅減少文件的撰寫時間,例如本篇影片中會介紹如何一鍵列出所有的 API 請求,並提供可測試的介面,這個流程就幾乎減少 20% ~ 30% 的時間,更別說她能夠將文檔與程式碼進行整合,做到有效的管理。

接下來,產文件將不需求人,讓你在未來成為別人家的好後端 👍👍👍

Yes

影片連結:https://youtu.be/L-MYeWFpXWE

本集範例程式碼:
https://github.com/Wcc723/node-ironman-sample-2023/tree/feature/swagger


上一篇
為專案中加入 Jest,避免未來的自己踩到現在挖的坑 👍
下一篇
從零開始介紹 JWT 驗證 - Day6
系列文
Node.js 實戰密技與辦公室的小壞壞:即戰力釋放讓總裁的心動瞬間30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言