1. 程式人生 > >Web開發筆記 #07# Swagger Editor

Web開發筆記 #07# Swagger Editor

Swagger Editor是一款可以用yaml格式文字設計RESTful API的工具,並且能夠實時看到自動生成的文件。效果大概是這樣的↓

根據官方網站介紹,如果是團隊的話,建議用線上的SwaggerHub(似乎是有很多便於開發的套件);個人solo開發則建議下載本地的Swagger Editor。

因為不熟悉Node.js,所以簡單記錄一下安裝流程:

1、首先需要安裝Node.js的儘可能新的版本,這個時候npm也會一起配套安裝好。直接去官方網站下載就行了。

2、來到Swagger Editor的github頁面把壓縮包下載到本地(或者clone)

3、解壓到資料夾,這個時候可以看到有個index.html檔案,直接點開就能用了,並且編輯之後直接關閉也不會丟失資料(儲存在瀏覽器的本地儲存中)

另外一種方法是啟動靜態伺服器來開啟編輯器,這需要做一些額外工作:

1、執行命令:npm install -g http-server (安裝一個類似web容器的東西)

2、用安裝好的工具啟動靜態伺服器訪問Swagger Editor。命令列切換到有index.html的那個目錄下,執行命令:http-server -p 埠號