API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

Swagger-UIを使用して静的ドキュメントを作成する方法を紹介しました。「API GatewayをエクスポートしてSwagger-UIを使う方法

その他にも静的ドキュメント生成ツールはたくさんあるようで、Redocを紹介します。

コマンドラインから生成するのでredoc-cliをインストールします。

バージョン確認します。

項目 バージョン
redoc-cli 0.9.4

API GatewayからOpenAPIのyamlをエクスポートします。「lambda-dev-oas30-apigateway.yaml」というファイル名とします。

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

redoc-cliではローカルサーバで起動して静的HTMLを見る方法と、静的HTMLを生成する方法の2通りあります。

redoc-cliコマンドでローカルサーバで起動する

カレントディレクトリにyamlを配置して以下を実行します。

http://127.0.0.1:8080」を起動します。

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

奇麗にレンダリングされています。

redoc-cliコマンドで静的HTMLを生成する

今度は先ほどレンダリングされたHTMLを生成します。

デフォルトでは「doc-static.html」が作成されますがオプションでファイル名は変更可能です。詳細はヘルプを見てください。

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

静的HTMLが生成されていることが確認できます。

no summary?

生成されたHTMLを見ると、no summaryと表示されています。これはyamlにsummaryがないからです。

yamlのGETの部分にsummaryを追加します。

これで再度HTMLを生成します。

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

summary(要約)が表示されました。その他にも色々詳細な記述が出来るので、「What Is OpenAPI?」を参照ください。

その他、HTML生成時にオプションで--options.hideDownloadButton=trueをつけるとダウンロードボタンが非表示になります。

redoc-cli bundle lambda-dev-oas30-apigateway.yaml --options.hideDownloadButton=true

--options.pathInMiddlePanel=trueをつけるとpathが表示されるようになります。

API GatewayからSwagger +API Gateway 拡張の形式でエクスポートしたファイルからRedoc-CLIで静的ドキュメントを作成する方法

スポンサーリンク
  • このエントリーをはてなブックマークに追加
  • Evernoteに保存Evernoteに保存
スポンサーリンク

コメントをどうぞ

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です

CAPTCHA