yaml - 将 Swagger 规范 JSON 转换为 HTML 文档

Question

对于一些用 PHP 编写的 REST API，我被要求创建 Swagger文档，并且由于我不知道有任何简单的方法来注释这些现有 API 并创建此类文档，因此我使用了 this editor暂时生成一些。

我保存了使用该编辑器创建的 JSON 和 YAML 文件，现在我需要从那里创建“交互式”Swagger 文档。

有人可以告诉我如何将 Swagger JSON 规范文件转换为实际的 Swagger 文档吗？

我是Windows平台，对Ant/Maven一无所知。

Answer 1

2023 年 5 月 17 日更新

似乎 redoc-cli 已被弃用。所以使用https://www.npmjs.com/package/@redocly/cli反而。 [来源:@Dave]

尝试使用redoc-cli。

我正在使用bootprint-openapi通过它我生成了一堆文件(bundle.js，bundle.js.map，index.html，main.js)。 css 和 main.css.map)，然后您可以使用 html-inline 将其转换为单个 .html 文件生成一个简单的 index.html 文件。

然后我发现redoc-cli非常容易使用，输出真的很棒 - 2 一个单一且漂亮的index.html文件。

安装:

npm install -g redoc-cli

用法:

redoc-cli bundle -o index.html swagger.json