00090-FastAPI 学习笔记

Python

发布日期: 2023-09-09

更新日期: 2024-12-28

前言

用于学习 FastAPI，FastAPI 框架，高性能，易于学习，高效编码，生产可用。

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 web 框架，使用 Python 3.6+ 并基于标准的 Python 类型提示。

源教程地址: https://fastapi.tiangolo.com/zh/ .

项目仓库: https://github.com/LuYF-Lemon-love/simple-FastAPI .

操作系统：Windows 10 专业版

参考文档

FastAPI

环境

git clone git@github.com:LuYF-Lemon-love/simple-FastAPI.git
cd simple-FastAPI/
python -m venv env
source env/bin/activate
which python
pip install --upgrade pip
pip install fastapi
pip install "uvicorn[standard]"

示例

创建一个 main.py 文件并写入以下内容:

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

或者使用 async def...

如果你的代码里会出现 async / await，请使用 async def：

from typing import Union

from fastapi import FastAPI

app = FastAPI()


@app.get("/")
async def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
async def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}

通过以下命令运行服务器：

uvicorn main:app --reload

关于 uvicorn main:app --reload 命令......

uvicorn main:app 命令含义如下:

main：main.py 文件（一个 Python “模块”）。
app：在 main.py 文件中通过 app = FastAPI() 创建的对象。
--reload：让服务器在更新代码后重新启动。仅在开发时使用该选项。

使用浏览器访问 http://127.0.0.1:8000/items/5?q=somequery 。你将会看到如下 JSON 响应：

{"item_id": 5, "q": "somequery"}

你已经创建了一个具有以下功能的 API：

通过路径 / 和 /items/{item_id} 接受 HTTP 请求。

以上路径都接受 GET 操作（也被称为 HTTP 方法）。

/items/{item_id} 路径有一个路径参数 item_id 并且应该为 int 类型。

/items/{item_id} 路径有一个可选的 str 类型的查询参数 q。

现在访问 http://127.0.0.1:8000/docs 。你会看到自动生成的交互式 API 文档（由 Swagger UI生成）：

访问 http://127.0.0.1:8000/redoc 。你会看到另一个自动生成的文档（由 ReDoc 生成）：

示例升级

现在修改 main.py 文件来从 PUT 请求中接收请求体。我们借助 Pydantic 来使用标准的 Python 类型声明请求体。

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()


class Item(BaseModel):
    name: str
    price: float
    is_offer: Union[bool, None] = None


@app.get("/")
def read_root():
    return {"Hello": "World"}


@app.get("/items/{item_id}")
def read_item(item_id: int, q: Union[str, None] = None):
    return {"item_id": item_id, "q": q}


@app.put("/items/{item_id}")
def update_item(item_id: int, item: Item):
    return {"item_name": item.name, "item_id": item_id}