Thinking more...: 用 redoc 來顯示OpenAPI規格文件

之前有找過怎樣輸出 OpenAPI 規格為文件，有試過 swagger-codegen 先轉成 HTML 再轉 PDF，但其實效果不好，也一直沒找到滿意的。

今天再來找一次，找到 redoc，依照 github 網站上的說明來作，用 redoc 提供的 docker image 就可以跑起 API 文件的 Live 網站，效果挺好的。

docker run -p 8081:80 --rm -v $(pwd)/api.yml:/usr/share/nginx/html/api.yml -e SPEC_URL=api.yml redocly/redoc

網站上還有提到一個 redoc-cli，說明說可以 bundle 成一個靜態HTML文件。有 homebrew ，就想說 homebrew 會不會有這個 formula，找了以後，發現是沒有，只好認命的用 npm 來裝

npm install npx

npm install redoc-cli

裝 npx 是為了可以方便的呼叫 node module 裡的指令來用，這部份的使用說明可以參考這篇：Introducing npx: an npm package runner 。

裝好以後，就可以使用了：

npx redoc-cli bundle api.yml

輸出的檔案固定是 redoc-static.html，用瀏覽器開啟就可以了。

Thinking more...