使用 FastAPI 快速构建高效 RESTful API-JavaScript中文网-JavaScript教程资源分享门户

随着前后端分离的趋势，RESTful API 的需求越来越大。对于前端开发者来说，如何快速搭建一个高效的 RESTful API 是非常重要的。FastAPI 是一个基于 Python 的现代化 Web 框架，它能够快速构建高性能的 RESTful API。本文将介绍如何使用 FastAPI 构建一个高效的 RESTful API，并提供详细的指导意义和代码示例。

什么是 FastAPI

FastAPI 是一个基于 Python 的现代化 Web 框架，它提供了高性能、易于开发和易于维护的能力。FastAPI 独特的地方在于它使用了 Python 3.6+ 中的类型注解、异步和 OpenAPI 规范（前称 Swagger 规范）来自动生成 API 文档。这使得开发者能够在一定程度上避免手写文档的麻烦，同时也提高了 API 的可读性和可维护性。

如何使用 FastAPI 构建 RESTful API

在开始构建 RESTful API 前，您需要先安装 FastAPI 和 uvicorn。可以通过以下命令来安装：

pip install fastapi uvicorn

安装完成后，您需要创建一个 Python 文件（例如 app.py），并首先导入 FastAPI 和一些它需要的依赖项。以下是一个基本的示例：

from fastapi import FastAPI

app = FastAPI()

上面的示例创建了一个 FastAPI 实例，并将其赋值给了变量 app。

定义 API 路由

接下来，我们需要定义 API 路由。API 路由决定了可以响应哪些请求。在 FastAPI 中，我们可以使用装饰器来定义路由。

以下是一个示例：

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

在上面的示例中，我们使用了 @app.get("/") 声明了一个 GET 请求的路由。这个路由使用了名为 root 的异步函数来响应请求。当用户访问 API 的根路径时，它将返回一个简单的 JSON 数据。

请求参数

通常情况下，API 都有一些额外的参数来帮助我们更好地处理请求。FastAPI 提供了许多方法来处理这些额外的参数。

路径参数

路径参数通常用于从 URL 中获取值。例如，我们想要从 URL 中获取一个名为 item_id 的参数。我们可以像下面这样编写代码：

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

在上面的示例中，我们使用了包含一个参数项 {item_id} 的 URL。这个参数可以从函数 read_item 的参数列表中获取。FastAPI 会自动将参数值转换成 int 类型，这样我们就可以在代码中直接使用整数。

查询参数

查询参数通常用于向 API 传递一些附加的信息。例如，我们想要从 URL 中传递一个名为 q 的查询参数，我们可以像下面这样编写代码：

from typing import Optional

@app.get("/items")
async def read_item(q: Optional[str] = None):
    if q:
        return {"message": f"查询参数是 {q}"}
    return {"message": "没有查询参数"}

在上面的示例中，我们使用了一个名为 q 的参数，它是可选的。如果存在查询参数 q，则将其值作为 message 的一部分返回。

请求体

请求体通常用于在 POST、PUT 和 PATCH 等请求中传递数据。例如，我们想要向 API 上传递一个 JSON 数据，我们可以像下面这样编写代码：

// javascriptcn.com 代码示例
from typing import Optional

from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float
    is_offer: Optional[bool] = None

@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    return {"item_id": item_id, "item_name": item.name, "item_price": item.price, "item_is_offer": item.is_offer}

在上面的示例中，我们定义了一个名为 Item 的基本模型，它表示了一个简单的物品。我们可以在 API 路由中使用它来接收请求主体。在 update_item 函数中，我们使用 item: Item 序列化请求参数。

构建一个完整的 API

通过上面的示例，我们了解了 FastAPI 的基础知识和各种类型的请求参数。现在，我们可以构建一个完整的 RESTful API，并将其部署到生产环境中。

以下是一个完整的示例：

// javascriptcn.com 代码示例
from fastapi import FastAPI
from pydantic import BaseModel

app = FastAPI()

class Item(BaseModel):
    name: str
    price: float
    is_offer: bool = None

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

@app.get("/items/{item_id}")
async def read_item(item_id: int, q: str = None):
    return {"item_id": item_id, "q": q}

@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    return {"item_id": item_id, "item_name": item.name, "item_price": item.price, "item_is_offer": item.is_offer}

通过上面的示例，我们可以看到如何在 FastAPI 中构建一个完整的 RESTful API。在运行此代码之前，请确保已经安装了 FastAPI 和 uvicorn。您可以使用以下命令来启动 API：

uvicorn app:app --reload

通过这个命令，我们启动了一个名为 app 的 Python 文件中的 FastAPI 应用程序，并使用 --reload 标志启用了热重载。这使得在代码发生更改时，应用程序将自动重新加载。

总结

使用 FastAPI 构建高效的 RESTful API 是非常容易且快速的。它为我们提供了许多有用的工具和功能，使开发过程更加流畅和高效。希望本文对您有所帮助，并且能够帮助您更快地入门 FastAPI。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/6533caac7d4982a6eb763e50