正文

新手必看！FastAPI框架入门实战教程，轻松学会高效构建API

/0 浏览量
0718

在这个数字化时代，API（应用程序编程接口）已经成为了软件开发中不可或缺的一部分。FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API，使用 Python 3.6+。它具有异步架构，这使得它比其他许多框架更快，并且非常适合构建高性能的 API。

以下是一个关于 FastAPI 框架的入门实战教程，帮助你轻松学会高效构建 API。

了解 FastAPI

FastAPI 是由 Sebastián Ramírez 开发的，它是一个全新的 Web 框架，旨在提供一种简单而强大的方式来构建 API。它的设计目标是易于学习和使用，同时提供高性能和高效的生产力。

核心特点：

  • 异步处理：FastAPI 使用 Starlette 作为 Web 框架和 Uvicorn 作为 ASGI 服务器，这意味着它可以异步处理请求，从而提供更高的性能。
  • 自动文档生成：FastAPI 自动生成交互式 API 文档，使用 Swagger UI 和 ReDoc。
  • 类型安全：FastAPI 使用 Python 的数据类型注解来验证请求和响应，确保数据的有效性和类型安全。
  • 依赖注入：FastAPI 提供了强大的依赖注入系统，可以轻松地将服务、数据库和缓存等集成到你的应用中。

快速开始

安装 FastAPI

首先，你需要安装 FastAPI 和 Uvicorn。你可以使用 pip 来安装：

pip install fastapi uvicorn

创建你的第一个 FastAPI 应用

创建一个新的 Python 文件（例如 main.py），并添加以下代码：

from fastapi import FastAPI

app = FastAPI()

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

保存文件并运行：

uvicorn main:app --reload

打开浏览器访问 http://127.0.0.1:8000/，你应该会看到以下输出：

{
    "Hello": "World"
}

这表示你的 FastAPI 应用已经成功启动并运行。

构建一个简单的 API

让我们创建一个更复杂的 API，它包含多个端点：

from fastapi import FastAPI, HTTPException

app = FastAPI()

# 数据库模拟
fake_db = {
    "1": {"name": "Alice", "age": 25},
    "2": {"name": "Bob", "age": 30},
}

@app.get("/users/{user_id}")
async def get_user(user_id: str):
    user = fake_db.get(user_id)
    if not user:
        raise HTTPException(status_code=404, detail="User not found")
    return user

@app.post("/users/")
async def create_user(name: str, age: int):
    user_id = str(len(fake_db) + 1)
    fake_db[user_id] = {"name": name, "age": age}
    return {"id": user_id, "name": name, "age": age}

这里我们创建了一个用于获取用户信息的端点 /users/{user_id}，以及一个用于创建新用户的端点 /users/。

依赖注入

FastAPI 的依赖注入系统非常强大，可以让你轻松地将服务、数据库和缓存等集成到你的应用中。

from fastapi import FastAPI, HTTPException
from pydantic import BaseModel

app = FastAPI()

class User(BaseModel):
    name: str
    age: int

fake_db = {
    "1": {"name": "Alice", "age": 25},
    "2": {"name": "Bob", "age": 30},
}

@app.get("/users/{user_id}")
async def get_user(user_id: str, db: dict = Depends(fake_db)):
    user = db.get(user_id)
    if not user:
        raise HTTPException(status_code=404, detail="User not found")
    return user

在这个例子中，我们使用 Depends 来注入一个依赖项，它是一个字典，模拟了数据库。

结论

通过这个入门实战教程，你应该已经对 FastAPI 有了一个基本的了解，并且能够创建简单的 API。FastAPI 是一个功能强大的框架，适用于构建高性能的 API，并且它的学习和使用都非常简单。

希望这个教程能够帮助你轻松学会高效构建 API。如果你有任何问题，欢迎在评论区留言。

-- 展开阅读全文 --