簡體   English   中英

sqlmodel:向 Field() 添加示例

[英]sqlmodel: adding an example to a Field()

在pydantic中我們可以給Fields添加一個例子,比如:

Field(default=None, example="A very nice Item")

然后將顯示在 swagger API 文檔中:

https://fastapi.tiangolo.com/img/tutorial/body-fields/image01.png

我們如何在 sqlmodel 中執行此操作? 在sqlmodel中的Field class中添加key example返回錯誤:

Field() 得到了一個意想不到的關鍵字參數 'example'

謝謝!

可以使用schema_extra來完成:

Field(default=None, schema_extra={'example': "A very nice Item"})

可以在代碼中找到:

https://github.com/tiangolo/sqlmodel/blob/267cd42fb6c17b43a8edb738da1b689af6909300/sqlmodel/main.py#L119

暫無
暫無

聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.

 
粵ICP備18138465號  © 2020-2024 STACKOOM.COM