Skip to main content
 首页 » 编程设计

python之Swagger-codegen之如何自定义客户端 SDK 调用名称

2024年09月03日31JeffreyZhao

我是 Swagger 的新手。我有一个现有的 RESTful API,并希望创建一个 native python 包装器库。

是否可以将 SDK 生成为面向对象的库?

例子:

对于像

这样的请求

GET /root/level/{name}/division/{division}

我正在获取生成的 Python 函数

root_level_name_division_division_get() 

是否可以生成一个对象结构,允许像下面这样的工作流?

div = root.level[name].division[division] 
root.level[name].division[other_division] = div # This is for PUT 

请您参考如下方法:

Swagger Codegen 根据operationIds 生成方法名, 将回退到路径名。例如,如果您的 API 定义指定

paths: 
  /root/level/{name}/division/{division}: 
    get: 
      operationId: getDivisionById 
      ... 

生成的Python函数会被命名

def get_division_by_id(self, name, division, **kwargs) 


Is it possible to generate an object structure allowing workflow like following?

div = root.level[name].division[division] 
root.level[name].division[other_division] = div # This is for PUT 

不是开箱即用的,但你可以create a custom codegen template这将以您需要的格式生成源代码。