[筆記] 六角學院 Node.js 2022 直播班記錄 – 16 Swagger 初步教學

章節連結

近期正參加六角學院的 Node.js 2022 直播班,想說做個紀錄並當作複習之用。這邊筆記下如何使用 Swagger,並產出該文件給前端使用。
hex-school-logo


課程相關資訊

[連結]:https://www.hexschool.com/courses/nodejs.html

請注意:本系列文章為個人對應課程的消化吸收後,所整理出來的內容。換言之,並不一定會包含全部的課程內容,也有可能會添加其他資源來說明。


核心概念

1. 有文件比沒文件好很多,Swagger 僅是一直一種方式。沒有文件形同通靈。
2. 使用 swagger-ui-express 和 swagger-autogen ( 目前建議安裝 2.5.10 )

swagger-autogen

用來生成 swagger 所需的 json 檔

swagger-ui-express

在進入點中引入此程式和方才生成的 json 檔案,並使用 app.use () 引入相關檔案即可

swagger 的內容註解

介面上的 Parameter…等資訊,是藉由在 controller 內撰寫註解來達成的

詳細的使用方式,可以上 swagger-autogen npm 來查詢


系列文章

  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 9 Mongoose 連線基本操作
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 8 – Promise, async 和 await
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 7 – MongoDB 操作 CRUD 相關指令(下)
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 6 – MongoDB 操作 CRUD 相關指令
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 5 – MongoDB 環境建置
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 4 – 佈署到 Heroku 遠端
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 3 – POSTMAN 和自建 TodoList API Server
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 2 – npm
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 18 multer 上傳到 imgur 功能
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 17 JWT 登入註冊功能
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 15 全方面的 Error 管理
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 14 Middleware 設計
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 13 Express 框架初探
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 12 連接遠端資料庫和環境變數設置
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 11 Mongoose 實作運用
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 10 Mongoose 額外補充和模組化
  • [筆記] 六角學院 Node.js 2022 直播班記錄 – 1 – Node.js 介紹和 node 模組原理
  • 按讚加入粉絲團

    延伸閱讀