ReDocとは

ReDocとは、OpenAPI/Swagger仕様で記述されたyamlファイルからhtmlファイルを生成し、静的なドキュメント作成をするツール。

API仕様書の作成手順

MacOS Catalina

brew install nodebrew
nodebrew -v
nodebrew ls-remote
nodebrew setup
echo 'export PATH="$HOME/.nodebrew/current/bin:$PATH"' >> ~/.bash_profile

nodebrew install-binary stable
nodebrew ls
nodebrew use stable
nodebrew ls
node -v

brew install yarn
yarn -v

mkdir redoc_sample
cd redoc_sample
yarn add redoc
yarn add redoc-cli
yarn list redoc

vim swagger.yml

swagger.ymlの作成例等を参考にOpenAPI/Swaggerフォーマットに則りyamlファイルを作成

npx redoc-cli bundle swagger.yml -o index.html
open index.html