FastAPI：使用Python构建快速API|极客教程

FastAPI：使用Python构建快速API

在当今世界中，API（Application Programming Interface，应用程序编程接口）是不可或缺的一部分。API使得不同的系统能够互相通信和交换数据，从而实现更高效的软件开发和系统集成。随着云计算和微服务的兴起，API的需求和重要性进一步提升。在构建API时，选择一个高效且易于使用的框架是至关重要的。

FastAPI 是一个现代化的 Web 框架，专注于使用 Python 3.6+ 进行快速 API（也可用于 Web 应用程序）开发。它基于 Starlette 和 Pydantic 构建，并通过使用 Python 类型提示提供更好的代码自动补全和错误检查。FastAPI 还提供了异步能力，能够处理数千个请求，具有出色的性能。本文将介绍 FastAPI 的基本概念、功能和使用方法，帮助你快速上手并构建高效的 API。

安装与准备

在使用 FastAPI 之前，我们首先需要安装 FastAPI 和 uvicorn（ASGI 服务器）。可以通过 pip 来安装：

pip install fastapi uvicorn

安装完成后，我们可以创建一个简单的 FastAPI 应用程序并运行它。首先创建一个 Python 文件（如 main.py ）并编写以下代码：

from fastapi import FastAPI

# 创建 FastAPI 应用实例
app = FastAPI()

# 创建一个路由，当访问根路径时返回消息
@app.get("/")
async def read_root():
    return {"message": "Hello, FastAPI"}

# 运行应用程序
if __name__ == "__main__":
    import uvicorn
    uvicorn.run(app, host="0.0.0.0", port=8000)

在终端中运行以下命令启动 FastAPI 应用程序：

uvicorn main:app --reload

现在，打开浏览器并访问 http://127.0.0.1:8000，你将看到返回的消息 “Hello, FastAPI”。

路由与请求处理

在上面的示例中，我们创建了一个简单的路由来处理根路径的 GET 请求。FastAPI 提供了 @app.get、@app.post、@app.put、@app.delete 等装饰器，用来定义不同 HTTP 方法的路由。另外，FastAPI 还支持异步请求处理，通过使用 async def 来定义异步函数。

让我们创建一个接受 POST 请求并返回带有用户信息的 JSON 数据的路由：

from fastapi import FastAPI, Body

app = FastAPI()

@app.post("/user/")
async def create_user(user: dict = Body(...)):
    return user

在这个示例中，我们定义了一个接受 POST 请求的路由 /user/，其中请求体中应包含一个 JSON 对象，并将其作为参数 user 传递给路由处理函数。通过使用 Body(...)，我们告诉 FastAPI 从请求体中获取数据，并将其作为参数传递给函数。在这里我们简单地返回接收到的用户信息。

请求参数与类型校验

除了从请求体中获取数据，FastAPI 也支持从查询参数、路径参数、请求头等位置获取数据。我们可以使用 Pydantic 模型类来定义请求参数，并通过类型提示来实现自动校验和转换。

让我们创建一个接受查询参数的路由，并根据参数返回不同的消息：

from fastapi import FastAPI, Query

app = FastAPI()

@app.get("/items/")
async def read_item(name: str = Query(...)):
    return {"item": name}

在这个示例中，我们创建了一个接受 name 查询参数的路由 /items/，然后返回一个包含参数值的 JSON 对象。通过使用 Query(...)，我们告诉 FastAPI 将 name 参数解析为字符串，并自动生成文档。如果请求中没有 name 参数或参数不是字符串类型，FastAPI 将返回 422 错误。这样我们可以确保传递给路由的参数是符合预期的。

文档生成与自动交互

一个好的 API 应该具有易于理解和使用的接口，文档与交互式工具对于快速学习和调试 API 非常重要。FastAPI 内置了 Swagger UI 和 ReDoc，能够自动生成完整的 API 文档，并提供交互式的 API 浏览页面。

当我们启动 FastAPI 应用程序时，默认情况下会自动生成 API 文档，并可以通过浏览器访问 http://127.0.0.1:8000/docs 或 http://127.0.0.1:8000/redoc 查看文档。

中间件与异常处理

FastAPI 支持中间件机制，允许我们在处理请求前后执行自定义逻辑。中间件可以用于认证、日志记录、性能跟踪等方面。下面是一个简单的中间件示例，用于记录请求的路径和响应时间：

from fastapi import FastAPI
from fastapi.middleware.httpsredirect import HTTPSRedirectMiddleware
from fastapi.middleware.cors import CORSMiddleware
from fastapi.middleware.trustedhost import TrustedHostMiddleware
from fastapi.middleware.gzip import GZipMiddleware

app = FastAPI()

# 添加中间件
app.add_middleware(HTTPSRedirectMiddleware)
app.add_middleware(CORSMiddleware, allow_origins=["*"], allow_methods=["*"], allow_headers=["*"])
app.add_middleware(TrustedHostMiddleware, allowed_hosts=["your-host.com"])
app.add_middleware(GZipMiddleware)

除了中间件外，FastAPI 也提供了异常处理机制，能够捕获和处理运行时发生的异常。FastAPI 默认的异常处理器会返回错误信息以及适当的 HTTP 错误代码。我们也可以自定义异常处理器，根据不同的情况返回自定义的错误信息。