FastAPI

创建一个 FastAPI 项目

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

   

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

   • 选择 FastAPI 作为项目类型。

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

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

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

   项目 venv

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

   基础 conda

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

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

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

   

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

   • 从列表中选择 Python 版本。

   • 指定环境名称。

   • PyCharm 会检测 conda 安装。

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

   

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

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

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

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

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

   

   • 从环境类型列表中选择 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 的路径，可能需要重新加载环境。

   

   要重用 Virtualenv、Pipenv 或 Poetry 环境：

   • 将 类型 切换为 Python。

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

4. 点击 创建。

使用编码辅助开发应用程序

在开发 FastAPI 应用程序时，您可以利用 IDE 中提供的编码辅助功能。

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

  

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

  

  

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

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

   

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

   

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

   

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

   

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

3. 您还可以执行 .http 文件以测试 GET 请求。 您可以单独运行每个请求，或者点击 位于 .http 文件工具栏上，一次测试所有请求。

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

   

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

   

   在 执行 HTTP 请求 中了解有关 HTTP 请求的更多信息。