重复的子模型类名会导致相互覆盖

[zqabc]

位于不同api文件的不同入参模型，会相互覆盖。
具体见下，假如我有2个api，api_a.py里具有子模型Sub，api_b.py里也具有子模型Sub，那么在生成的api文档里2个接口入参显示是一样的

api_a.py

class Sub(BaseModel):
    special_p1: str
class Data(BaseModel):
    p1: str
    sub: Sub

class AApi(View):
    def get(self, request, data: Data = Query(exclusive=True)):
        ....

api_b.py

class Sub(BaseModel):
    special_p2: str
class Data(BaseModel):
    p2: str
    sub: Sub

class BApi(View):
    def get(self, request, data: Data = Query(exclusive=True)):
        ....

具体原因是pydantic生成的$ref是按类模型名称生成的，在构建OpenAPI文档时放入definitions的key，如果类名称一样那么key就一样，也即会覆盖。

讨论下怎么解决这个问题？
1、在构建pydantic模型时多加一个参数指明模型的绝对位置，接着在生成openapi.json时也使用这个参数生成唯一的ref引用？
2、pydantic的schema方法是否就可以生成带前缀的ref？

[abersheeran]

好问题！我觉得 2 更好。

[zqabc]

2 我找了下暂时还没找到pydantic的处理方法，你有看到吗？

[abersheeran]

https://pydantic-docs.helpmanual.io/usage/schema/#schema-customization

应该可以用 module.qualname 作为前缀来保证不重复。

[zqabc]

def schema_response(content: Union[Type[BaseModel], Dict]) -> Tuple[Dict, Dict]:
    if isinstance(content, dict):
        return content, {}
    module_name = content.__module__.replace('.', '__')
    ref_template = '#/definitions/' + module_name + '__{model}'
    schema = deepcopy(content.schema(ref_template=ref_template))
    definitions = schema.pop("definitions", {})
    tmp = deepcopy(definitions)
    for k, v in tmp.items():
        definitions[module_name + '__' + k] = v
        del definitions[k]
    return {"application/json": {"schema": schema}}, definitions

pydantic只能指定ref_prefix，其生成的definitions的key仍是class name😳，这里感觉不是很好的处理了下