write ahead log

ロールフォワード用

redoc-cliを使ってopenapi(swagger)を書く

肌に合ったツールがわからなくて困ってたけど、良いのがわかったのでメモしとく。

準備する

nodeはインストールされているとして。

とりあえずプロジェクト用のディレクトリを用意してredoc-cliをインストールする。

mkdir api-project
cd api-project
npm install redoc-cli

プレビューしながら書く

それっぽくopenapiのyamlを書く。

vi api.yml

プレビューするためにサーバーを起動する。

npx redoc-cli serve api.yml --watch

これで

localhost:8080

へのアクセスでプレビューしながら編集できる。

HTMLとして出力する

単一の依存なしHTMLファイルとして出力できる。便利。

npx redoc-cli bundle api.yml