为 Swagger 生成离线文档

Question

我需要为 Rest/Json api 生成离线文档（PDF / docx / Standalone html），但有一些限制：

很少的额外信息：它是 Uvnicorn 服务器（Python3.9）生成 openapi（3.0.2）jsonschema

目标是提供 1 个文档，提供与 SwaggerUI 类似的信息（每个端点，带有 http 代码、响应架构、示例）

本文档需要提供可读信息，无需任何额外的工具（例如pdf就可以），到目前为止我最好的尝试是使用这个：https://stackoverflow.com/a/46484079/15719786

但是仍然有一堆导入的脚本和抄送，要么需要单独的文件，要么需要在线

Answer 1

您可以使用 Redocly 独立 html

下载 Redocly cli npm 包。

npm install @redocly/cli:latest

使用

build-docs

命令创建独立的 html 文件

redocly build-docs <path/to/api> --output <filename.html>

您可以使用此命令通过

theme

和

config

选项进行许多其他自定义操作。