打开API生成器：更改客户端名称

Question

我正在使用“OpenApi 生成器”为 api 创建客户端库。

openapi-generator generate -i https://xxxx.cloudfront.net/openapi/en-us/product/2-0/openapi.yaml -g ruby -o tmp/test/custom_name

这会生成一个类“OpenapiClient”，但我需要将此名称更改为“CustomApiClient”。我怎样才能传递这个值？ 在我看来，这似乎是一件标准的事情，为什么不那么立即呢？我是否遵循最佳实践？

# Load the gem
require 'openapi_client'

# Setup authorization
OpenapiClient.configure do |config|
  # Configure Bearer authorization: bearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

Answer 1

这似乎比应有的更难找到，但如果你运行

openapi-generator config-help -g ruby

，它将向你显示 ruby 客户端配置的所有选项。具体来说，

gemName

。所以你可以简单地创建一个配置文件，例如：

# config.yaml
gemName: custom_api_client

并在运行生成命令时提供

-c /path/to/your/config.yaml

。

Answer 2

解决此问题的另一种方法是，您可以使用 --additionalProperties 参数来传入其中一些属性。在某些情况下，CICD 管道可能更适合您

比如制作一个python客户端，可以看它具体需要的参数： https://openapi-generator.tech/docs/generators/python/#config-options

https://openapi-generator.tech/docs/configuration/

那么你可以运行这样的东西：

openapi-generator generate -i https://xxxx.cloudfront.net/openapi/en-us/product/2-0/openapi.yaml -g python -o tmp/test/custom_name --additional-properties=packageName=my_client,packageVersion=0.5.3