fastapi 用法
- 1、下载文档前请自行甄别文档内容的完整性,平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益,请联系客服反馈,我们会尽快为您处理(人工客服工作时间:9:00-18:30)。
fastapi 用法
FastAPI 是一个现代、快速(基于Starlette 和Pydantic)、Web 框架,用于构建API。
以下是一些FastAPI 的基本用法:
1. 安装FastAPI:
使用pip 安装FastAPI:
```bash
pip install fastapi
```
2. 创建一个FastAPI 应用:
```python
from fastapi import FastAPI
app = FastAPI()
```
3. 定义一个简单的路由:
```python
@app.get("/")
def read_root():
return {"Hello": "World"}
```
这个路由表示当你访问根路径("/") 时,将会执行`read_root` 函数并返回一个JSON 响应。
4. 运行应用:
保存上述代码为`main.py`,然后使用以下命令运行应用:
```bash
uvicorn main:app --reload
```
这将在`http://127.0.0.1:8000` 启动你的应用,`--reload` 选项会在代码发生变化时自动重新加载应用。
5. 使用路径参数和查询参数:
```python
from fastapi import Path, Query
@app.get("/items/{item_id}")
def read_item(item_id: int, q: str = None):
return {"item_id": item_id, "q": q}
```
这个路由接受一个路径参数`item_id` 和一个查询参数`q`。
6. 使用请求体和响应模型:
```python
from pydantic import BaseModel
class Item(BaseModel):
name: str
description: str = None
price: float
tax: float = None
@app.post("/items/")
def create_item(item: Item):
return item
```
这个路由通过POST 请求接受一个JSON 请求体,该请求体需要符合`Item` 模型的结构。