iT邦幫忙

2022 iThome 鐵人賽

DAY 26
0
Modern Web

用 Node.js 打造後端 API系列 第 26

Day 26 - 生成API文件

  • 分享至 

  • xImage
  •  

前言


在完成後端API的功能後
我們可以透過Docgen
把在Postman測試的HTTP request
整理成一份index.html

匯出collection


Export CodingSchool_API collection
https://ithelp.ithome.com.tw/upload/images/20221004/20151654r46ZrAu4ko.png
匯出的檔案為json file

在下載docgen生成API文件前
需要先下載Homebrew
作為管理應用程式的套件
接著依據不同的作業系統
使用不同command來下載docgen

生成API文件


輸入以下的command:

brew install docgen

cd到json所在的位置

cd Desktop

生成文件

docgen build -i fileName.json -o index.html

完成後,將index.html移到public folder
(記得使用static middleware)

app.use(express.static('public'));

打開localhost:5000就能看到以下的畫面:
https://ithelp.ithome.com.tw/upload/images/20221004/20151654z9LBFz45KV.png


上一篇
Day 25 - API安全性2
下一篇
Day 27 - Push API到GitHub上
系列文
用 Node.js 打造後端 API30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言