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

Question

我是OpenAPI 3.0.0的新手。

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

但是OpenAPI生成器允许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。也可以作为markdown发出。参见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定义。