猫头虎分享：Python库 FastAPI 的简介、安装、用法详解入门教程

猫头虎

发布于 2024-08-14 14:40:38

910

发布于 2024-08-14 14:40:38

📄 摘要

作为一名专注于Python和人工智能开发的技术博主，猫头虎经常在开发过程中遇到各种挑战。最近，有粉丝问到如何高效地构建API，尤其是与机器学习模型集成的场景。在本篇博客中，我们将详细介绍一个近年来崛起的Python库——FastAPI，它因其高性能和易用性受到开发者的喜爱。

FastAPI被认为是构建快速、现代Web APIs的理想选择。本文将从简介、安装、基本用法到实际案例演示，带你全面了解如何使用FastAPI快速构建功能强大的API服务。📈

注意：本文将深入探讨一些关键技术点，帮助你轻松上手，并在未来的项目中更好地应用。

猫头虎是谁？

大家好，我是猫头虎，别名猫头虎博主，擅长的技术领域包括云原生、前端、后端、运维和AI。我的博客主要分享技术教程、bug解决思路、开发工具教程、前沿科技资讯、产品评测图文、产品使用体验图文、产品优点推广文稿、产品横测对比文稿，以及线下技术沙龙活动参会体验文稿。内容涵盖云服务产品评测、AI产品横测对比、开发板性能测试和技术报告评测等。

目前，我活跃在CSDN、51CTO、腾讯云开发者社区、阿里云开发者社区、知乎、微信公众号、视频号、抖音、B站和小红书等平台，全网拥有超过30万的粉丝，统一IP名称为猫头虎或者猫头虎博主。希望通过我的分享，帮助大家更好地了解和使用各类技术产品。

🚀 1. FastAPI 简介

🤔 什么是 FastAPI？

FastAPI 是一个用于构建Web APIs的现代、快速（基于Starlette和Pydantic）、高性能Python框架。FastAPI不仅可以让开发者快速编写代码，还能生成自动的API文档，极大提高了开发效率。

📋 主要特点：

性能卓越：基于 ASGI（Asynchronous Server Gateway Interface），性能与 Node.js 和 Go 相媲美。
数据验证：利用 Pydantic 强大的数据验证功能，确保数据的完整性和正确性。
自动文档：内置 Swagger 和 ReDoc 文档生成，API 文档自动生成，无需额外配置。
异步支持：原生支持异步编程，轻松处理大量并发请求。

FastAPI 是现代**Python Web**开发的利器，特别适合需要高性能的应用场景，如机器学习模型的在线部署。

🛠️ 2. FastAPI 的安装

安装 FastAPI 非常简单，只需要几条命令即可。下面是详细步骤：

🖥️ 步骤1：创建虚拟环境

为了避免环境冲突，建议先创建一个虚拟环境。使用以下命令创建虚拟环境并激活它：

python3 -m venv fastapi_env
source fastapi_env/bin/activate

📥 步骤2：安装 FastAPI 和 Uvicorn

安装 FastAPI 和 Uvicorn（一个支持 ASGI 的轻量级高性能 Web 服务器），使用以下命令：

pip install fastapi uvicorn

注意：Uvicorn 是部署 FastAPI 应用的推荐选择，它支持异步编程，性能优越。

🧑‍💻 3. FastAPI 的基本用法

接下来，我们将演示如何使用 FastAPI 构建一个简单的API服务。

🚧 步骤1：创建一个 FastAPI 应用

首先，创建一个 main.py 文件，代码如下：

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: str = None):
    return {"item_id": item_id, "q": q}

🚀 步骤2：运行应用

使用 Uvicorn 运行 FastAPI 应用：

uvicorn main:app --reload

解释：main:app 指定了要运行的文件（main.py）和应用实例（app），--reload 选项用于在代码更新时自动重启服务器。

访问 http://127.0.0.1:8000 可以看到我们的API服务已经运行起来了。访问 http://127.0.0.1:8000/docs 还能看到自动生成的API文档。

🛠️ 4. 高级用法与案例

FastAPI 不仅支持简单的 GET 和 POST 请求，还能处理更复杂的逻辑。下面是一个更复杂的例子：

🌐 案例：构建一个用户注册 API

这个例子展示了如何处理 POST 请求，数据验证，以及异常处理。

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    username: str
    email: str
    password: str

@app.post("/register/")
def register_user(user: User):
    if user.username == "admin":
        raise HTTPException(status_code=400, detail="Username 'admin' is not allowed.")
    return {"username": user.username, "email": user.email}

💡 技术点剖析：

数据模型：利用 Pydantic 定义用户数据模型，确保输入数据的格式和类型。
异常处理：通过 HTTPException 处理异常情况，返回适当的错误响应。

❓ 5. 常见问题解答 (QA)

💬 Q1: FastAPI 支持异步编程吗？

A: 支持。FastAPI 原生支持异步编程，您可以在路由函数中使用 async def 轻松处理异步操作。

💬 Q2: 如何在 FastAPI 中使用中间件？

A: FastAPI 支持中间件，您可以通过 @app.middleware("http") 装饰器来定义自定义中间件。

from fastapi import FastAPI
from starlette.middleware.base import BaseHTTPMiddleware

app = FastAPI()

@app.middleware("http")
async def add_process_time_header(request, call_next):
    response = await call_next(request)
    response.headers["X-Process-Time"] = str(time.time())
    return response

💬 Q3: FastAPI 能处理文件上传吗？

A: 可以。您可以使用 File 和 UploadFile 来处理文件上传，具体实现如下：

from fastapi import FastAPI, File, UploadFile

@app.post("/uploadfile/")
async def create_upload_file(file: UploadFile):
    return {"filename": file.filename}