OpenAPI 命令行工具：根据规范生成客户端代码

OpenAPI 命令行工具：根据规范轻松生成客户端代码

OpenAPI 命令行工具是一个强大的工具，可根据 OpenAPI 规范文件自动生成客户端代码。这简化了 API 客户端的开发，并确保了与 API 规范的一致性。

用法

openapi [options]

选项

| 选项 | 描述 ||---|---|| -V, --version | 显示版本号 || -i, --input <value> | OpenAPI 规范文件，可以是路径、URL 或字符串内容（必填） || -o, --output <value> | 输出目录（必填） || -c, --client <value> | 生成的 HTTP 客户端类型 [fetch, xhr, node, axios, angular]（默认值：'fetch'） || --name <value> | 自定义客户端类名 || --useOptions | 使用选项而非参数 || --useUnionTypes | 使用联合类型而非枚举 || --exportCore <value> | 是否将核心文件写入磁盘（默认值：true） || --exportServices <value> | 是否将服务文件写入磁盘（默认值：true） || --exportModels <value> | 是否将模型文件写入磁盘（默认值：true） || --exportSchemas <value> | 是否将模式文件写入磁盘（默认值：false） || --indent <value> | 缩进选项 [4, 2, tab]（默认值：'4'） || --postfixServices | 服务名称后缀（默认值：'Service'） || --postfixModels | 模型名称后缀 || --request <value> | 自定义请求文件路径 || -h, --help | 显示此帮助信息 |

示例

从本地文件生成客户端代码：

openapi --input ./spec.json --output ./generated

从本地文件生成客户端代码，并指定客户端类型为 'xhr'：

openapi --input ./spec.json --output ./generated --client xhr

结论

OpenAPI 命令行工具是简化 API 客户端开发的宝贵工具。通过利用此工具，您可以根据 OpenAPI 规范自动生成客户端代码，从而节省时间并减少错误。