openapi-generator-online 镜像文档

镜像概述和主要用途

openapi-generator-online 是用于将 openapi-generator 作为 Web 服务运行的 Docker 镜像。openapi-generator 是一款根据 OpenAPI 规范（原 Swagger 规范）生成 API 客户端、服务器存根、文档等的工具，本镜像通过 Web 服务形式提供其功能，支持远程调用和集成。

核心功能和特性

• 将 openapi-generator 功能封装为 Web 服务，支持通过 HTTP 请求使用 API 生成能力
• 简化 openapi-generator 的部署和使用流程，无需本地安装即可通过网络访问
• 支持自定义配置，通过环境变量调整服务参数

使用场景和适用范围

• 团队共享 API 生成服务，方便多成员通过网络访问统一的 API 生成工具
• 自动化构建流程中集成 API 生成步骤，通过 HTTP 请求触发代码生成
• 需要远程提供 OpenAPI 规范解析和代码生成能力的场景

使用方法和配置说明

拉取镜像

bash
docker pull openapitools/openapi-generator-online

运行容器

bash
docker run -d -e GENERATOR_HOST=[***] -p 80:8080 openapitools/openapi-generator-online

参数说明：

• -d：后台运行容器
• -e GENERATOR_HOST=[***]：设置环境变量，指定服务器 IP 地址（需替换为实际服务器 IP）
• -p 80:8080：端口映射，将容器内的 8080 端口映射到主机的 80 端口

配置说明

• 环境变量：GENERATOR_HOST 为必填项，用于指定 Web 服务的访问地址，格式为 http://[服务器IP]，需替换为实际部署服务器的 IP 地址

参考文档

更多详细信息，请参考 ***文档