6 安装与配置之安装 Uvicorn
在上一篇教程中,我们讨论了如何安装和配置 FastAPI
,为你将要开发的 API 提供一个强大的框架。而本篇教程将专注于如何安装和配置 Uvicorn
,这是一个支持 FastAPI
应用的高性能 ASGI 服务器。
什么是 Uvicorn?
Uvicorn
是一个轻量级的 ASGI 服务器,旨在提供高性能的异步 Web 服务器。它是开源的,并且非常容易与 FastAPI
一起使用。实际上,FastAPI
推荐使用 Uvicorn
作为其开发环境中的默认服务器。
安装 Uvicorn
1. 安装步骤
在你的 Python 环境中安装 Uvicorn
是相当简单的。你可以使用 pip
来完成这个安装。打开终端或命令提示符,执行以下命令:
1 | pip install uvicorn |
可以通过以下命令验证 Uvicorn
是否成功安装:
1 | uvicorn --version |
如果你能看到版本号,那么恭喜你,Uvicorn
已成功安装!
2. 运行 FastAPI 应用
现在我们来一个简单的例子,展示如何使用 Uvicorn
运行你的 FastAPI
应用。创建一个新的 Python 文件(例如 main.py
),并粘贴以下代码:
1 | from fastapi import FastAPI |
在代码中,我们创建了一个简单的 FastAPI
应用,并定义了一个根路由 /
,当访问这个路由时将返回一个 JSON 对象 {"Hello": "World"}
。
3. 启动 Uvicorn 服务器
在终端中,进入你存放 main.py
的目录,执行以下命令来启动 Uvicorn
:
1 | uvicorn main:app --reload |
这里的命令参数说明如下:
main:app
表示要加载的模块和应用对象,main
是你的 Python 文件名(不带.py
后缀),app
是我们在文件中定义的FastAPI
应用实例。--reload
参数表示应用会在代码更改时自动重载,非常适合开发环境。
4. 访问你的 FastAPI 应用
此时,你的应用应该已经在 http://127.0.0.1:8000
上运行了。你可以在浏览器中访问这个地址,应该可以看到 JSON 响应:
1 | { |
此外,FastAPI
还会自动生成 OpenAPI 文档,你可以访问 http://127.0.0.1:8000/docs
来查看 API 文档界面。
小结
在本篇教程中,我们成功安装并配置了 Uvicorn
,并使用它来运行一个简单的 FastAPI
应用。这为你建筑更复杂的 API 奠定了基础。在下一篇中,我们将深入理解 FastAPI
的核心概念,讨论请求与响应机制。通过学习这些关键概念,你将能够更有效地构建和管理你所开发的 API。
希望你能通过本系列教程顺利掌握 FastAPI
的使用!若有任何疑问,欢迎随时提出。
6 安装与配置之安装 Uvicorn