如何使用 openapi-generator 生成 API 文档？

Question

我是OpenAPI3.0.0 的新手。

我已经使用openapi-generator成功创建了一个 java 客户端库。

但是OpenAPIGenerator 允许生成 API 客户端库（SDK 生成）、服务器存根、文档。所以我想知道是否有任何命令或步骤可用于生成 HTML 文档以及自定义文档模板。

Answer 1

老问题，但对于那些仍然遇到它的人。OpenApi Generator 可以根据 API 的 yaml 或 json 定义生成 html 文档。

openapi-generator generate -i PathToMyInputDefinitionFile.yaml -g html -o /PathToOutputFolder

html您要使用的生成器在哪里。其他生成器包括dynamic-html和html2。也可以作为降价发出。请参阅https://openapi-generator.tech/docs/generators/

如果使用 Docker，完整示例如下所示：

docker run --rm -v ${PWD}:/local openapitools/openapi-generator:tagname generate -i /local/input.yaml -g html -o /local

PWD 是主机中的当前工作目录（当前目录），您将其映射到容器中的 /local。调整“标签名”以适应，来自https://hub.docker.com/r/openapitools/openapi-generator/tags 调整input.yaml为您的 API 的输入文件 yaml 定义。