了解 FastAPI 基础知识：FastAPI、Uvicorn、Starlette、Swagger UI 和 Pydantic 指南

心靈之曲

发布时间：2024-11-03 22:45:10

1547人浏览过

来源于dev.to

转载

了解 fastapi 基础知识：fastapi、uvicorn、starlette、swagger ui 和 pydantic 指南

fastapi 是一个现代的高性能 web 框架，用于使用 python 构建 api，使开发人员能够以最少的努力创建强大且高效的应用程序。它的设计考虑了异步编程，使其速度极快并且能够同时处理多个请求。为 fastapi 提供支持的关键组件包括 uvicorn、starlette、swagger ui 和 pydantic。在本指南中，我们将探索每个组件，并了解它们如何在 fastapi 中组合在一起，并使用代码示例来演示关键概念。

1. fastapi的核心

fastapi 建立在两个主要基础之上：

异步编程：利用python的async和await，fastapi可以同时处理多个请求，对于需要并发的应用程序来说非常高效。
类型注释：fastapi 使用 python 的类型提示来自动验证和序列化请求和响应数据，这使得开发更快、更安全。

让我们从一个简单的 fastapi 应用程序开始，了解其结构：

# main.py

from fastapi import fastapi

app = fastapi()

@app.get("/")
async def read_root():
    return {"hello": "world"}

这是一个基本的 fastapi 应用程序，具有单个路由 (/)，返回带有 {"hello": "world"} 的 json 响应。

要运行此应用程序，您将使用 uvicorn，一个旨在为异步 web 应用程序提供服务的 asgi 服务器。

2. uvicorn：asgi 服务器

uvicorn 是一个快如闪电的 asgi 服务器，针对处理异步代码进行了优化。它对于运行 fastapi 应用程序至关重要，因为它处理传入的 http 请求并管理这些请求的生命周期。

要使用 uvicorn 运行 fastapi 应用程序，请使用以下命令：

uvicorn main:app --reload

main:app 指定 uvicorn 应在 main.py 文件中查找应用程序实例。
--reload 在开发过程中启用热重载，因此每当您保存更改时服务器都会自动重新加载。

当您运行此命令时，uvicorn 将开始为您的 fastapi 应用程序提供服务，您可以通过 http://127.0.0.1:8000 访问它。

3. starlette：fastapi 的 web 框架基础

fastapi 构建于 starlette 之上，后者是一个轻量级 asgi 框架，用于处理核心 http 操作，包括路由、中间件和 websockets 支持。 starlette 提供了 fastapi 用于管理 http 请求的低级工具，使其成为构建 web 应用程序的稳定且高性能的基础。

fastapi 利用 starlette 的路由系统来定义 api 端点。例如：

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    return {"item_id": item_id}

在此示例中：

@app.get("/items/{item_id}") 定义带有路径参数 item_id 的路由。
fastapi 通过将 starlette 的路由系统与其类型检查和验证集成来处理此路径参数类型（此处为 int）。

starlette 还允许您添加中间件以进行各种操作，例如处理 cors（跨源资源共享）、请求日志记录或自定义身份验证：

from starlette.middleware.cors import corsmiddleware

app.add_middleware(
    corsmiddleware,
    allow_origins=["*"],
    allow_credentials=true,
    allow_methods=["*"],
    allow_headers=["*"],
)

starlette 的这种灵活性使得 fastapi 具有高度可配置性，允许开发人员根据需要轻松添加自定义中间件。

4. swagger ui：交互式 api 文档

fastapi 使用 swagger ui 自动生成交互式 api 文档。该文档默认在 /docs 中提供，并允许开发人员直接从浏览器测试端点。

Imagen – Google Research

Google Brain team推出的图像生成模型。

下载

要查看实际效果，请启动 fastapi 应用程序并访问 http://127.0.0.1:8000/docs。您将看到一个交互式 swagger ui，其中列出了您的所有路线、其参数以及预期响应。

另一个文档接口，redoc，默认也在 /redoc 提供，提供更详细的 api 规范视图。

5. pydantic：数据验证和序列化

fastapi 最强大的方面之一是它使用 pydantic 进行数据验证。 pydantic 模型允许您定义具有严格类型约束和自动验证的请求和响应数据的结构。

让我们在示例中添加 pydantic 模型：

from fastapi import fastapi
from pydantic import basemodel

app = fastapi()

# define a pydantic model
class item(basemodel):
    name: str
    price: float
    is_offer: bool = false

# use the model in an endpoint
@app.put("/items/{item_id}")
async def update_item(item_id: int, item: item):
    return {"item_id": item_id, "item": item}

在此代码中：

item模型继承自basemodel，定义了三个字段：name、price、is_offer。这些字段具有特定的数据类型和 is_offer 的可选默认值。
当您使用 json 数据向 /items/{item_id} 发送请求时，fastapi 使用 pydantic 根据 item 模型验证数据，并在可能的情况下自动转换数据类型。

尝试使用位于 /docs 的 swagger ui 发送这样的请求：

{
  "name": "sample item",
  "price": 29.99
}

fastapi 将验证数据并在数据与预期类型不匹配时自动返回任何错误。例如，如果价格以字符串形式给出（如“20”），fastapi 将响应详细的验证错误。

6. 将它们放在一起

让我们通过添加更多路线并结合迄今为止学到的所有内容来扩展我们的应用程序：

from fastapi import fastapi, httpexception
from pydantic import basemodel
from starlette.middleware.cors import corsmiddleware

app = fastapi()

# define a pydantic model
class item(basemodel):
    name: str
    price: float
    is_offer: bool = false

# add cors middleware
app.add_middleware(
    corsmiddleware,
    allow_origins=["*"],
    allow_credentials=true,
    allow_methods=["*"],
    allow_headers=["*"],
)

# home route
@app.get("/")
async def read_root():
    return {"hello": "world"}

# get an item by id
@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = none):
    if item_id == 0:
        raise httpexception(status_code=404, detail="item not found")
    return {"item_id": item_id, "q": q}

# update an item
@app.put("/items/{item_id}")
async def update_item(item_id: int, item: item):
    return {"item_id": item_id, "item": item}

使用此设置：

路由和参数处理：@app.get("/items/{item_id}")端点演示路径参数和查询参数（例如q）。
异常处理：使用 httpexception 进行自定义错误响应（例如，当找不到项目时）。
cors：cors 中间件允许您从不同的域发出请求，这对于 web 应用程序中的前后端通信至关重要。

运行应用程序

要运行此应用程序，请使用 uvicorn：

uvicorn main:app --reload

导航到 http://127.0.0.1:8000/docs 以查看交互式文档，或使用 curl 或 postman 等工具将请求发送到不同的端点。

概括

fastapi 将异步编程的性能优势与 python 类型提示的简单性相结合，创建了一个快速、易于使用且适合生产应用程序的框架。通过集成 uvicorn、starlette、swagger ui 和 pydantic，fastapi 提供了一种极其简化的 api 开发方法，使其成为快速原型设计和生产级应用程序的绝佳选择。

掌握了这些核心基础知识后，您现在就可以更深入地了解 fastapi 的世界并构建可扩展的高性能应用程序。