字典列表 swagger python

Question

我还想在我的 swagger 文档中指定字典列表和该字典的键，

class GetCustomerDetailsByIdPOUT(BaseModel):
    profileData: Customer
    scanData : Reports
    Scan: list
 

目前，我得到这个

 "Scan": [
    "string"
  ]

您还可以在图像中看到

我想要这样的东西

"scans": [
                {
                "id": 0,
                "cameraId": 0,
                "reportId": 0,
                "sequenceNo": 1,
                "raw": [
                    "string"
                ],
                "spectrum": 1,
                "view": 1
                }
            ]

Answer 1

我认为您没有提供有关列表将包含的信息。 我不知道你想在那里有什么，但是例如：

from typing import List

class GetCustomerDetailsByIdPOUT(BaseModel):
    profileData: Customer
    scanData : Reports
    Scan: List[MyScan]

在类型提示中，您可以提供类型 - 您 class 或内置类型，如List[float] 。

对于 python <= 3.8 你应该使用 typing 模块，对于 3.9+ 你不必。 有关键入别名的更多信息。

此外，如果可能，请考虑将您的命名约定与PEP8 对齐。 例如profileData -> profile_data 。