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

Related #js

Next.js 11

手軽にアップグレードできた

仕事ですぐに使えるTypeScript

奥が深い

prismのモックサーバはexamples定義からレスポンスを返してくれる

仕様書を作る際はexamplesも定義するようにしておきたい

明日のゴミ収集対象をSlackに通知する

これでもう翌日のゴミ収集内容に迷わない