当前位置：首页 > news >正文

使用 VSCode 开发 FastAPI 项目（1）

news 来源：原创 2025/6/12 20:05:06

一、引言

FastAPI 是一款现代、快速（高性能）的 Web 框架，用于构建 API，使用 Python 3.7 及更高版本。它基于标准 Python 类型提示，具有自动生成文档等出色功能。而 VSCode 凭借其轻量、强大的特性，为开发者提供了卓越的编码体验。本文将逐步指导你在 VSCode 中搭建 FastAPI 项目，并高效进行开发。

二、环境搭建

1. 安装 VSCode

从官方网站（Visual Studio Code - Code Editing. Redefined）下载适合你操作系统的 VSCode 版本并安装。安装过程简单直观，按照向导提示完成即可。

2. 安装 Python 扩展

在 VSCode 中打开扩展视图（快捷键 Ctrl + Shift + X），搜索 “Python”，找到由 Microsoft 提供的 Python 扩展并安装。该扩展能为 Python 文件提供智能感知、调试等功能，为后续开发奠定基础。

3. 创建项目文件夹

在本地磁盘中创建一个文件夹用于存放 FastAPI 项目，例如 “D:\python\fastapi_project”。这个文件夹将成为你的项目根目录，项目的一切相关文件都将存放于此。

4. 创建虚拟环境

打开 VSCode 的终端（快捷键 Ctrl + ），在项目根目录下执行命令 python -m venv venv` 创建虚拟环境。第一个 “venv” 是 Python 的模块名，第二个 “venv” 是你创建的虚拟环境文件夹名。这样可以为项目创建一个独立的 Python 运行环境，避免不同项目之间的依赖冲突。

5. 激活虚拟环境

Windows 环境 ：在终端中运行 .\venv\Scripts\activate，激活后命令行提示符前会显示虚拟环境名称。
macOS/Linux 环境 ：在终端中运行 source venv/bin/activate，成功激活后，终端提示符会有相应标识，表明当前处于虚拟环境。

三、安装依赖

1. 创建 requirements.txt 文件

在项目根目录下创建一个名为 “requirements.txt” 的文件。该文件用于指定项目所需的所有依赖库及其版本，方便后续安装和管理。添加以下内容：

复制

fastapi
uvicorn
pydantic
python-multipart

这些依赖库分别是 FastAPI 框架本身、ASGI 服务器、数据验证模型库以及处理多部分请求数据的库。

2. 安装依赖

在终端中运行 pip install -r requirements.txt，这将根据 requirements.txt 文件中的内容安装 FastAPI、Uvicorn 以及相关的依赖库。安装过程中，终端会显示详细的安装进度，完成后，项目所需的依赖环境就搭建好了。

四、编写代码

1. 创建项目结构

在项目根目录下创建一个名为 “demo1” 的文件夹，在其中新建 __init__.py 和 main.py 文件。

__init__.py 文件可以为空，它用于标识这是一个 Python 包，这样 Python 解释器就能将该文件夹识别为一个包，方便后续模块的导入和管理。
在 main.py 文件中编写 FastAPI 应用代码。

2. 编写 FastAPI 应用代码

在 main.py 文件中添加以下代码：

from fastapi import FastAPI
app = FastAPI()@app.get("/")
def read_root():return {"message": "Hello World,now start frist FastAPI"}

这段代码首先导入 FastAPI 类，创建一个 FastAPI 应用实例 app。然后定义一个简单的 GET 请求路由 “/”，当用户访问该路由时，返回一个包含 “Hello” 和 “World” 键值对的 JSON 响应。这为后续的 API 开发奠定了基础。

五、配置调试

1. 创建 launch.json 文件

在项目根目录下创建一个名为 “.vscode” 的文件夹，在其中创建 launch.json 文件。该文件用于配置 VSCode 的调试设置，添加以下配置：

{"version": "0.2.0","configurations": [{"name": "FastAPI: Uvicorn","type": "debugpy","request": "launch","module": "uvicorn","args": ["demo1.main:app",  // 替换为你的应用模块路径"--host", "0.0.0.0","--port", "8000","--reload"],"jinja": true,"justMyCode": true}]
}

其中，“name” 是调试配置的名称，“type” 指定调试类型为 “debugpy”，“request” 为 “launch” 表示启动调试。“module” 指定启动的模块是 “uvicorn”，“args” 中包含了运行 Uvicorn 服务器所需的参数，包括应用模块路径、主机地址、端口号以及热重载选项。“jinja” 和 “justMyCode” 则是一些调试相关的设置。

六、启动应用

1. 运行应用

在 VSCode 中打开调试视图（快捷键 Ctrl + Shift + D），选择 “FastAPI: Uvicorn” 配置，然后点击 “开始调试” 按钮或按 F5 键。这将启动 Uvicorn 服务器，运行 FastAPI 应用。终端会显示服务器的运行状态和日志信息，如监听的端口等。

2. 访问应用

打开浏览器，访问 http://127.0.0.1:8001，你应该会看到返回的内容为 {"Hello":"World"}。这表明你的 FastAPI 应用已经成功运行。此外，访问 http://127.0.0.1:8000/docs 可以查看自动生成的 API 文档，这是 FastAPI 的一大亮点，它基于应用中的路由和模型自动生成交互式文档，方便你和他人了解和测试 API。

七、其他建议

1. 代码格式化和类型检查

安装 Pylance 扩展，它可以帮助你检测代码中的类型错误，提高代码质量。你还可以安装 autopep8 或 black 等扩展来进行代码格式化，保持代码风格的一致性，提升代码的可读性。

2. 使用编辑器配置文件

创建 .editorconfig 和 pyproject.toml 文件来统一团队的代码风格和配置。.editorconfig 文件可以指定文件编码、缩进方式等通用的编辑器设置，而 pyproject.toml 文件可以配置 Python 项目相关的工具和参数，如依赖管理、测试工具等。

八、结语

通过以上步骤，你已经成功在 VSCode 中搭建并运行了一个 FastAPI 项目。这只是开发之旅的开始，你可以继续深入学习 FastAPI 的更多高级功能，如请求体验证、依赖注入、数据库集成等，结合 VSCode 的强大功能，如代码片段、多光标编辑等，进一步提升开发效率。希望本指南能为你在 Python Web 开发的道路上提供有价值的帮助，让你能轻松应对各种项目挑战，构建出高质量的 API 服务。