OpenAPI定義を元にAPIドキュメントhtmlを生成する

Stoplight Studioを使うとAPI仕様のyamlをGUIで手軽に作成できる。

作成した仕様書をブラウザから確認できるようにするため、redocを使ってyamlからhtml生成を行うようにした。

yarn add redoc-cli

↓のでもデモサイトのように見やすいドキュメントを生成してくれるのでとても良い。

watchオプションを付けるとyamlが更新されたらドキュメントを再生成してくれる。

yarn run redoc-cli serve --watch petshop.yaml