Swagger(yaml)ファイルからHTMLのAPI仕様書の作成方法

目次

• 概要
• redoc-cliのインストール
• API仕様書の作成

概要

こちらのAPI仕様書作成手順として、redoc-cli コマンドラインを使ってSwagger(yaml)ファイルからHTMLのAPI仕様書作成する手順になります。

手順

1. redoc-cliをインストールする
2. yamlファイルを準備する
3. redoc-cliコマンドを利用し、API仕様書を作成する

redoc-cliのインストール

npm install -g redoc-cliを実行し、redoc-cliをインストールする。

※最低nodeバージョンv12が必要

API仕様書の作成

yamlファイルを準備して、redoc-cli bundle inputFile.yaml -o API仕様書.html を実行し、HTMLのAPI仕様書作成する。
※yamlフィアルの代わりに、jsonファイルからも生成できる。

①yamlファイルを準備する。

②コマンドを実行する。

③API仕様書.htmlファイルが出来上がる。