如何使用 FastAPI 构建高性能的 API 服务

#如何使用 FastAPI 构建高性能的 API 服务

FastAPI 是一个现代化的、快速（高效）的 Web 框架，专为构建 API 而设计。它是基于 Python 类型提示的，并且支持异步编程，允许开发者构建高性能、高可用性的延迟低的 API 服务。本文将为您详细介绍如何使用 FastAPI 来构建高性能的 API 服务，我们将分步骤进行讲解，帮助您实现从环境搭建到部署的全过程。

##第一步：环境准备

您需要确保您的开发环境中安装了 Python 3.6+。如果还没有安装，可以访问 Python 官网 下载并安装。

###安装 FastAPI 和 Uvicorn

FastAPI 本身并不提供服务，需要一个 ASGI 服务器来承载。这里我们使用 Uvicorn，一个高性能的 ASGI 服务器。可以使用以下命令安装 FastAPI 和 Uvicorn：

pip install fastapi uvicorn

##第二步：构建基础 API

让我们创建一个简单的 FastAPI 应用。

###创建应用文件

在您的项目目录中，创建一个 Python 文件，比如 main.py，然后在其中编写如下代码：

from fastapi import FastAPI

app = FastAPI()

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

在以上代码中，我们首先导入了 FastAPI 并创建了一个 app 实例。然后，我们定义了一个 GET 路由，访问根路径 / 时返回一条简单的 JSON 响应。

###启动服务器

通过以下命令启动您的 FastAPI 服务器：

uvicorn main:app --reload

• main: 指的是文件名，不带 .py 后缀。
• app: 指的是 FastAPI 实例。
• --reload: 开发模式下，文件更改时自动重启服务器。

##第三步：定义路由与数据模型

为了建立复杂的 API，您需要使用 Pydantic 来定义数据模型。

###创建数据模型

在 main.py 中添加如下内容：

from pydantic import BaseModel

class Item(BaseModel):
    name: str
    price: float
    is_available: bool = True

这段代码使用 Pydantic 创建了一个数据模型 Item，它包含商品名称、价格和是否可用三种属性。

###增加新的路由

接着，我们可以定义一个新的 POST 路由来接收 Item 类型的数据：

@app.post("/items/")
async def create_item(item: Item):
    return {"item_name": item.name, "item_price": item.price}

在这个路由中，FastAPI 会自动验证传入的数据并将其映射到 Item 模型中。

##第四步：文档自动生成

FastAPI 的最大优势之一是可以自动生成 API 文档。您可以通过访问以下地址来查看：

• Swagger UI: http://127.0.0.1:8000/docs
• ReDoc: http://127.0.0.1:8000/redoc

在这些生成的文档中，您可以交互式地测试 API，查看每一个路由的请求和响应格式。

##第五步：添加身份验证

在实际应用中，身份验证是一个重要的环节。让我们添加一个简单的基于角色的身份验证。

###添加安全依赖项

使用 FastAPI 的 Depends 方法和 OAuth2PasswordBearer 来实现身份验证：

from fastapi import Depends, HTTPException, status
from fastapi.security import OAuth2PasswordBearer

oauth2_scheme = OAuth2PasswordBearer(tokenUrl="token")

async def fake_decode_token(token):
    return {"sub": token}

async def get_current_user(token: str = Depends(oauth2_scheme)):
    user = fake_decode_token(token)
    if user is None:
        raise HTTPException(status_code=status.HTTP_401_UNAUTHORIZED, detail="Invalid authentication credentials")
    return user

###保护路由

然后，您可以将身份验证添加到需要保护的路由中：

@app.get("/users/me")
async def read_users_me(current_user: dict = Depends(get_current_user)):
    return current_user

##第六步：部署 FastAPI 应用

当您完成开发后，您可能需要将应用部署到云服务器上。可以选择使用 Docker 部署。

###创建 Dockerfile

在项目目录中创建一个名为 Dockerfile 的文件，输入如下内容：

FROM tiangolo/uvicorn-gunicorn-fastapi:python3.8

COPY ./app /app

###构建 Docker 镜像

在您的终端中，使用以下命令构建 Docker 镜像：

docker build -t myfastapiapp .

###运行 Docker 容器

运行您的 FastAPI 应用：

docker run -d --name fastapi -p 80:80 myfastapiapp

##总结

在本文中，我们详细讲解了如何使用 FastAPI 构建高性能 API 服务，从环境准备到创建基础 API、定义路由和数据模型，再到添加身份验证和部署的完整过程。FastAPI 提供了许多强大的功能，使得构建现代 API 变得简单且高效，您可以通过官方文档进一步探索更多的功能和特性。希望这篇文章能够帮助您更快地上手 FastAPI，有效提升您的项目开发效率！