fastapi example

在FastAPI中，可以使用example参数来为请求体的字段提供示例数据。通过在Body函数中传递example参数，可以将示例数据传递给请求体中的字段。例如，可以在update_item函数中为Item模型的字段提供示例数据，如下所示：

@app.put("/items/{item_id}")
async def update_item(
    item_id: int,
    item: Item = Body(
        ...,
        example={
            "name": "Foo",
            "description": "A very nice Item",
            "price": 35.4,
            "tax": 3.2,
        },
    ),
):
    results = {"item_id": item_id, "item": item}
    return results

这样，在文档的UI中，将会显示出这个示例数据，供用户参考。请注意，example字段虽然不是JSON Schema的一部分，但它是OpenAPI的一部分，因此会在文档的UI中使用。同时，也可以使用Config和schema_extra来为Pydantic模型声明示例数据，更多细节可以参考Pydantic文档中的"定制Schema"部分。<span class="em">1</span><span class="em">2</span><span class="em">3</span>
#### 引用[.reference_title]
- *1* *2* *3* [FastAPI学习-9. Swagger文档输出请求示例example](https://blog.csdn.net/qq_27371025/article/details/123454301)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v92^chatsearchT0_1"}}] [.reference_item style="max-width: 100%"]
[ .reference_list ]