FastAPI--一个快速的 Python Web

FastAPI

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

文档：https://fastapi.tiangolo.com

关键特性：

快速：可与 NodeJS 和 Go 并肩的极高性能（归功于 Starlette 和 Pydantic）。最快的 Python web 框架之一。
高效编码：提高功能开发速度约 200％至 300％。
更少 bug：减少约 40％的人为（开发者）导致错误。
智能：极佳的编辑器支持。处处皆可自动补全，减少调试时间。
简单：设计的易于使用和学习，阅读文档的时间更短。
简短：使代码重复最小化。通过不同的参数声明实现丰富功能。bug 更少。
健壮：生产可用级别的代码。还有自动生成的交互式文档。
标准化：基于（并完全兼容）API 的相关开放标准：OpenAPI (以前被称为 Swagger，https://github.com/OAI/OpenAPI-Specification) 和 JSON Schema（https://json-schema.org）。

FastAPI 站在以下巨人的肩膀之上：

Starlette（https://www.starlette.io）负责 web 部分。
Pydantic（https://docs.pydantic.dev）负责数据部分。

安装

为了使用命令行运行之后的示例代码，安装时使用以下命令，比正常安装多了 standard，这可以同时安装 fastapi 的命令行工具：

pip install "fastapi[standard]"

首先示例代码：

main.py

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/await，可以使用 async def：

py 复制代码

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}

运行：

在命令行执行：fastapi dev main.py

然后访问：http://127.0.0.1:8000，可以看到 {"Hello":"World"}。

访问：http://127.0.0.1:8000/items/5?q=somequery，可以看到 {"item_id":5,"q":"somequery"}。

现在可以访问：http://127.0.0.1:8000/docs，将看到自动交互式 API 文档，直接在里面调试接口。

访问：http://127.0.0.1:8000/redoc，将看到替代的自动文档。

现在修改 main.py 从 put 请求接收一个 body。

py 复制代码

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}

修改完成并保存后，fastapi dev 服务应该自动重新加载。

现在可以去交互式文档看看，交互式 API 文档将自动更新，包括新的正文内容，可以测试接口是否正确。

FastAPI 很适合快速开发，自定义强，简单高效，很容易入门，文档也丰富，后续可以深入了解。