字典列表 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 。