fastapi.Query
时间: 2024-08-12 19:02:32 浏览: 104
fastapi-query-expansion:FastAPI查询扩展
FastAPI是一个现代高性能的Web框架,它构建在Python的asyncio和Starlette之上,特别适合RESTful API开发。`fastapi.Query`是FastAPI提供的一个装饰器,用于处理HTTP查询参数。当你需要从URL路径之外获取GET请求的参数时,可以使用`Query`。
例如,在定义一个路由时:
```python
from fastapi import FastAPI, Query
app = FastAPI()
@app.get("/items/")
def read_items(q: str = Query(..., title="Search term", description="The search term.")):
items = get_items_from_database(q)
return {"items": items}
```
在这个例子中,`q`是查询参数,如果没有提供,默认值是`...`,表示这是一个可选参数。`title`和`description`则是文档字符串,会显示在生成的API文档中,帮助开发者理解这个参数的作用。
使用`Query`装饰器的好处是,FastAPI会自动验证输入的类型,并且支持多种数据类型,如字符串、整数、浮点数等。如果传入的数据不符合预期类型,它还会抛出错误。
阅读全文