如何使用 FastAPI 框架构建 RESTful API

阅读时长 5 分钟读完

FastAPI 是一种快速 Web 框架,它基于 Python 3.6+ 版本的新特性,例如 async/await 语法。它提供了简单易用的 API,帮助我们使用 Python 构建高性能的 Web 应用程序和 RESTful API。在本文中,我们将探讨如何使用 FastAPI 框架构建 RESTful API。

安装和设置

安装 FastAPI 很简单,只需使用 pip 就可以完成:

同时,我们也需要安装一个 ASGI 服务器来运行 FastAPI。在本示例中,我们使用 Uvicorn:

接下来,我们需要创建一个 FastAPI 实例并定义一个基本路由。我们可以在 main.py 文件中编写以下代码:

接下来,在命令行中运行以下命令:

现在我们可以打开浏览器,在地址栏中输入 http://127.0.0.1:8000/,就可以看到我们的 API 返回了一条消息 "Hello World!"。我们现在已经成功构建了一个基本的 FastAPI 应用程序,让我们继续深入吧。

兼具异步与同步的能力

在 FastAPI 中,您可以编写同步代码或异步代码,具体取决于您的需求。异步代码可以让我们更好的处理大量的请求,达到更好的性能。但是,如果您更习惯同步代码的编写方式,FastAPI 同样支持。下面我们来看一下,如何在 FastAPI 中编写同步代码:

这里我们没有使用 async 关键字来修饰函数,这意味着这个函数是同步的。FastAPI 会根据您的代码选择使用同步或异步代码。如果您的代码不包含 async 关键词,FastAPI 将默认为同步模式。

使用 Pydantic 处理数据

在 FastAPI 中,我们使用 Pydantic 来保存和处理数据。Pydantic 是一个数据验证和解析库,它帮助我们处理数据并确保数据的有效性和一致性。让我们来看一下,如何在 FastAPI 中使用 Pydantic:

-- -------------------- ---- -------
---- ------ ------ --------
---- -------- ------ ---------

----- ----------------
    ----- ---
    ------ -----
    ------------ ------------- - ----

--------------------
----- --- ----------------- ------
    ------ ----

在上面的代码示例中,我们定义了一个 Item 类,继承自 Pydantic 的 BaseModel。这个类包含了我们需要的字段,例如 name 、price 和 description。我们还定义了一个 create_item 函数来处理 POST 请求。这个函数接收一个 Item 对象,自动验证并解析它。如果 Item 格式不正确,FastAPI 将自动返回一个 HTTP 422 错误。如果 Item 格式正确,FastAPI 将返回一个创建的 Item 对象。

使用路由参数和查询参数

在 FastAPI 中,我们可以使用路由参数和查询参数来处理请求。路由参数是 URL 中的一部分,用于标识请求的资源。查询参数是从 URL 中获取的参数,用于过滤和排序请求。下面,我们将展示如何使用 FastAPI 处理这些参数:

在上面的代码示例中,我们使用了一个路由参数 item_id 和一个查询参数 q。FastAPI 将根据 URL 中的参数解析出这些参数。如果您不提供查询参数 q,FastAPI 将使用默认值 None。如果您省略路由参数,或者参数格式不正确,FastAPI 将返回一个 HTTP 404 错误。

异常处理

在 FastAPI 中,您可以自定义异常处理函数。这允许您处理应用程序中的异常,以便更好地追踪错误和调试代码。下面,我们将展示一个异常处理函数的示例:

-- -------------------- ---- -------
---- ------- ------ -------- -------------

--- - ---------

----- - ---------- -------- --------- --------

----------------------------
----- --- ------------------ -----
    -- ------- --- -- ------
        ----- ------------------------------ ------------ --- -------
    ------ -------- ---------------

在上面的代码示例中,我们在路由处理函数中检查 item_id 是否存在于 items 列表中。如果没有找到这个 item,我们抛出了一个 HTTPException 异常,同时指定了 404 状态码和详细错误信息。如果 FastAPI 在处理路由时捕获到异常,它将自动返回一个错误响应,带有指定的状态码和详细错误信息。

结论

FastAPI 是一个快速 Web 框架,它基于 Python3.6+ 版本的新特性。它提供了简单易用的 API,帮助我们使用 Python 构建高性能的 Web 应用程序和 RESTful API。在本文中,我们涵盖了 FastAPI 的基本原理、安装和设置、兼具异步与同步的能力、使用 Pydantic 处理数据、使用路由参数和查询参数以及异常处理。我们希望这篇文章能够帮助您理解 FastAPI 的基本概念,并以此构建出更好的 Web 应用程序和 RESTful API。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/670d137c5f551281025c5ab5

纠错
反馈