繁体 English 中英

sqlmodel：向 Field() 添加示例

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

原文 2022-11-18 21:05:19 7 1 sqlmodel

在pydantic中我们可以给Fields添加一个例子，比如：

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

然后将显示在 swagger API 文档中：

我们如何在 sqlmodel 中执行此操作？ 在sqlmodel中的Field class中添加key example返回错误：

Field() 得到了一个意想不到的关键字参数 'example'

谢谢！

可以使用schema_extra来完成：

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

可以在代码中找到：

[英]How to generate a UUID field with FastAPI, SQLalchemy, and SQLModel

[英]How to define a CheckConstraint for an integer field in SQLModel

[英]Composite Indexes SQLModel

[英]sqlmodel: filter by null

[英]SQLModel with Pydantic validator

[英]BigInteger with fastapi and sqlmodel

[英]SQLmodel and group_by

[英]SQLModel: Forbid mutation

[英]How to add obj to db with sqlmodel

[英]Use PostGIS geometry types in SQLModel

暂无

声明:本站的技术帖子网页，遵循CC BY-SA 4.0协议，如果您需要转载，请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.

相关问题 如何使用 FastAPI、SQLalchemy 和 SQLModel 生成 UUID 字段如何为 SQLModel 中的 integer 字段定义 CheckConstraint 复合索引 SQLModel sqlmodel：按空过滤带有 Pydantic 验证器的 SQLModel 带有 fastapi 和 sqlmodel 的 BigInteger SQLmodel 和 group_by SQLModel：禁止突变如何使用 sqlmodel 将 obj 添加到 db 在 SQLModel 中使用 PostGIS 几何类型

相关标签