dullwhaleのメモ帳

何度も同じことを調べなくてよいように...

OpenAPIで記述したAPI仕様をRedocを使ってsingle fileのHTMLにする

いくつも方法があるものの、新しめの手法に中々たどり着けなかったからメモする。 この方法も(開発段階という意味で)previewらしいから変化する可能性が高い。注意が必要。

ライブプレビューする

ライブプレビューにはいくつか方法がある。 ここでは、ファイルをウォッチして自動で再ビルド、サーブしてくれる方法を説明する。 APIの定義があるファイルをapi.yamlとする。

npx @redocly/cli preview-docs api.yaml

デフォルトではlocalhost:8080でプレビューをサーブする。 WSLなどの環境で便利。 ただ、現時点では構文が間違っていると例外を吐いて勝手に終了してしまう問題がある。

single fileのHTMLを生成する

CIや他人との共有に備えて、一つのファイルで完結するHTMLを生成することもできる。

npx @redocly/cli build-docs api.yaml