FastAPI

创建 FastAPI 项目

1. 在主菜单中，转到 文件 | 新建项目 ，或在 欢迎屏幕 中点击 新建项目 按钮。

   

2. 在 新建项目 对话框中，执行以下操作：

   • 选择 FastAPI 作为项目类型。

   • 指定项目位置。 项目名称将根据指定路径中的文件夹名称自动生成。

   • 选择 创建Git 仓库 以 将项目置于 Git 版本控制之下。

3. 如果您想继续使用 项目 venv、 uv 或 基础 Conda 解释器，请选择相应选项并点击 创建。

   项目 venv

   PyCharm 会在项目文件夹中基于系统 Python 创建 virtualenv 环境。

   uv

   PyCharm 会将 uv 环境配置为项目解释器。

   基础 conda

   PyCharm 会将 conda 基础环境配置为项目解释器。

   要配置其他类型的解释器或使用现有环境，请选择 自定义环境。

   接下来的步骤取决于您的选择：

   

   • 在环境类型列表中选择 Virtualenv。

   • 从列表中选择基础解释器，或点击 在文件系统中找到 Python 可执行文件。

   • 在 位置 字段中指定新虚拟环境的位置，或点击 在文件系统中浏览位置。 新虚拟环境的目录应为空。

   • 如果您希望将计算机上全局 Python 中安装的所有包添加到将要创建的虚拟环境，请选中 从基础解释器继承软件包 复选框。 此复选框对应 virtualenv 工具的 --system-site-packages 选项。

   • 如果您希望在 PyCharm 中创建 Python 解释器时重用此环境，请选中 对所有项目可用 复选框。

   

   • 在环境类型列表中选择 Conda。

   • 从列表中选择 Python 版本。

   • 指定环境名称。

   • PyCharm 将检测到 conda 安装。

     如果 PyCharm 未自动检测到该安装，请指定 conda 可执行文件的位置，或点击 进行浏览。

   

   • 在环境类型列表中选择 Pipenv。

   • 从列表中选择基础解释器，或点击 在文件系统中找到 Python 可执行文件。

   • 如果您已将基础二进制目录添加到您的 PATH 环境变量，则无需设置任何其他选项：pipenv 可执行文件的路径将被自动检测到。

     如果 PyCharm 未检测到 pipenv 可执行文件，请点击 通过 pip 安装 pipenv ，允许 PyCharm 为您自动安装它。

     或者，按照 pipenv 安装流程 查找可执行文件路径，然后在对话框中指定它。

   

   • 在环境类型列表中选择 Poetry。

   • 从列表中选择基础解释器，或点击 在文件系统中找到 Python 可执行文件。

   • 如果 PyCharm 未检测到 Poetry 安装，请点击 通过 pip 安装 poetry ，允许 PyCharm 为您自动安装 Poetry。

     或者，指定 Poetry 可执行文件的位置，或点击 进行浏览。

   • 要在项目目录中创建虚拟环境，请选中 在项目中创建环境 复选框。

   

   • 在环境类型列表中选择 uv。

   • 从列表中选择 Python 版本。

   • PyCharm 将检测到 uv 安装。

     否则，请指定 uv 可执行文件的位置，或点击 进行浏览。

   

   • 在环境类型列表中选择 Hatch。

   • PyCharm 将检测到 Hatch 安装。

     否则，请指定 Hatch 可执行文件的位置，或点击 进行浏览。

   • 选择环境。

     Hatch 环境是为各种特定于项目的任务设计的工作区。 如果未明确选择环境，Hatch 将使用 默认环境。

   • 从列表中选择基础解释器，或点击 在文件系统中找到 Python 可执行文件。

   

   要重用现有 conda 环境：

   • 将 类型 切换为 Conda。

   • PyCharm 将检测到 conda 安装。

     如果 PyCharm 未自动检测到该安装，请指定 conda 可执行文件的位置，或点击 进行浏览。

   • 从列表中选择环境。 如果您手动指定了 conda 的路径，则可能需要重新加载环境。

   

   要重用其他 Python 环境：

   • 将 类型 切换为 Python。

   • 从列表中选择 Python 可执行文件，或点击 进行浏览。

4. 点击 创建。

使用编码辅助开发应用

开发 FastAPI 应用时，您可以受益于 IDE 中的编码辅助功能。

• 使用 检查 来分析代码问题。 您可以使用检查小部件简要预览问题摘要。 点击该小部件，在 问题 工具窗口中获取每个已检测问题的更多信息。

  

• 您可以使用具备上下文感知的 代码补全 来加快编码过程。 开始键入代码构造，补全弹出窗口会出现。 您也可以按 Ctrl+Space 以显示可用项。

  

  

启动并修改运行/调试配置

1. 创建新项目后，PyCharm 会为您提供一个运行/调试配置，以便您执行 FastAPI 应用。 创建的配置会在可用的运行/调试配置列表中被选中。 在运行小部件中点击 以启动您的应用。

   

   目标应用会在 运行 工具窗口中执行。 您可以点击该链接在浏览器中预览应用。

   

2. 您可以修改随项目创建的默认运行/调试配置。 在可用配置列表中选择 编辑配置…：

   

   在左侧窗格中选择目标配置并修改其参数——例如，您可以添加更多 uvicorn 选项（在本例中： --reload delay 10）。

   

   有关使用运行/调试配置的更多信息，请参阅 运行/调试配置。

3. 您还可以执行 .http 文件来测试 GET 请求。 您可以分别运行每个请求，或者在 .http 文件工具栏上点击 以一次性测试所有请求。

   选择在无环境的情况下执行请求，或在公共文件或私有文件中创建环境。

   

   PyCharm 会在 Services 工具窗口中执行 GET 测试。 您可以选择特定请求以预览其执行状态摘要。

   

   在 执行 HTTP 请求 中详细了解 HTTP 请求。