FastAPI 教程：从零开始学习 Python Web API – wiki大全

作者： /

FastAPI 教程：从零开始学习 Python Web API

在当今快速发展的 Web 服务领域，高效、高性能的 API 是构建现代应用程序的基石。Python 生态系统中涌现了众多 Web 框架，而 FastAPI 凭借其卓越的性能、易用性、以及内置的自动化文档功能，迅速成为开发者们的新宠。本教程将引导你从零开始，一步步学习如何使用 FastAPI 构建强大的 Python Web API。

什么是 FastAPI？

FastAPI 是一个用于构建 API 的现代、快速（高性能）的 Python Web 框架，它基于标准的 Python 类型提示构建，并充分利用 Starlette（用于 Web 部分）和 Pydantic（用于数据验证和序列化）的强大功能。其主要特点包括：

  • 极高的性能：与 Node.js 和 Go 并驾齐驱，得益于 Starlette 和 Uvicorn。
  • 快速开发：基于类型提示自动生成数据模型和请求验证，减少了大量样板代码。
  • 健壮性：数据验证和序列化由 Pydantic 自动处理，减少运行时错误。
  • 内置交互式 API 文档：自动生成 OpenAPI（以前称为 Swagger）和 ReDoc 文档。
  • 易于使用和学习：语法简洁，易于理解。
  • 支持异步：全面支持 async/await，处理高并发请求。

准备工作

在开始之前，确保你的系统安装了 Python 3.7+。

  1. 创建虚拟环境（推荐）

    bash
    python -m venv venv
    source venv/bin/activate # macOS/Linux
    ./venv/Scripts/activate # Windows

  2. 安装 FastAPI 和 Uvicorn

    FastAPI 是框架本身，Uvicorn 是一个 ASGI 服务器，用于运行 FastAPI 应用程序。

    bash
    pip install fastapi "uvicorn[standard]"

你的第一个 FastAPI 应用：Hello World!

让我们从一个简单的“Hello World” API 开始。

创建一个名为 main.py 的文件：

“`python
from fastapi import FastAPI

app = FastAPI()

@app.get(“/”)
async def read_root():
return {“message”: “Hello World”}
“`

现在，运行你的应用：

bash
uvicorn main:app --reload

  • main: 指的是 main.py 文件。
  • app: 指的是在 main.py 文件中创建的 FastAPI() 实例。
  • --reload: 可以在代码更改时自动重启服务器，方便开发。

打开浏览器访问 http://127.0.0.1:8000，你将看到 {"message": "Hello World"}。

访问 http://127.0.0.1:8000/docs 或 http://127.0.0.1:8000/redoc，你将看到自动生成的交互式 API 文档！

路径参数（Path Parameters）

API 通常需要从 URL 中获取动态数据。

修改 main.py：

“`python
from fastapi import FastAPI

app = FastAPI()

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

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

访问 http://127.0.0.1:8000/items/5，将返回 {"item_id": 5}。FastAPI 会自动验证 item_id 是否为整数。

查询参数（Query Parameters）

查询参数是 URL 中 ? 后面跟着的键值对。

修改 main.py：

“`python
from fastapi import FastAPI
from typing import Optional

app = FastAPI()

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

@app.get(“/items/{item_id}”)
async def read_item(item_id: int, q: Optional[str] = None):
if q:
return {“item_id”: item_id, “q”: q}
return {“item_id”: item_id}
“`

访问 http://127.0.0.1:8000/items/5?q=somequery，将返回 {"item_id": 5, "q": "somequery"}。
Optional[str] = None 表示 q 是一个可选的字符串参数，默认为 None。

请求体（Request Body）与 Pydantic 模型

对于 POST、PUT 等请求，通常需要客户端发送 JSON 数据作为请求体。FastAPI 使用 Pydantic 来定义数据模型，并自动进行验证。

创建一个 Pydantic 模型：

“`python
from fastapi import FastAPI
from typing import Optional
from pydantic import BaseModel

class Item(BaseModel):
name: str
description: Optional[str] = None
price: float
tax: Optional[float] = None

app = FastAPI()

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

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

@app.post(“/items/”)
async def create_item(item: Item):
return item
“`

现在，你可以使用 POST 请求向 http://127.0.0.1:8000/items/ 发送 JSON 数据。例如，使用 curl：

bash
curl -X POST -H "Content-Type: application/json" -d '{"name": "Foo", "price": 10.5}' http://127.0.0.1:8000/items/

将返回你发送的 JSON 数据，并且 FastAPI 会自动验证 name 是字符串，price 是浮点数。

高级特性概览

  • 依赖注入（Dependency Injection）：FastAPI 强大的功能，允许你声明函数参数的依赖项，框架会自动处理它们的注入。这使得代码模块化、可测试性强。
  • 安全性与认证（Security and Authentication）：内置对 OAuth2 with JWT、HTTP Basic 认证等多种安全方案的支持。
  • CORS (Cross-Origin Resource Sharing)：轻松配置 CORS，允许或禁止特定来源的跨域请求。
  • WebSocket：支持 WebSocket，用于构建实时应用程序。
  • 背景任务（Background Tasks）：允许你在 API 响应发送后执行一些任务，而不会阻塞主请求。
  • 测试：FastAPI 的设计使其非常容易进行测试，推荐使用 pytest。
  • 错误处理：自定义异常处理器，返回更友好的错误信息。

总结

FastAPI 提供了一种现代、高效且愉悦的方式来构建 Python Web API。通过利用 Python 的类型提示，它不仅提升了开发效率，还增强了代码的健壮性和可维护性。其自动生成的文档功能更是为 API 的使用者带来了极大的便利。

从“Hello World”到处理路径参数、查询参数和请求体，你已经掌握了 FastAPI 的核心概念。接下来，你可以深入研究其高级特性，如依赖注入、认证授权、WebSocket 等，以构建更复杂、更完善的 Web 服务。祝你在 FastAPI 的世界里探索愉快！

滚动至顶部