快速API

创建一个 FastAPI 项目

1. 从主菜单中，选择文件 | 新建项目，或单击欢迎屏幕中的新建项目按钮。新建项目对话框打开。

   

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

   • 指定项目类型FastAPI。

   • 位置：保留建议的项目位置或指定替代目录。

   • • 新环境使用：如果已选择此选项，请选择用于创建虚拟环境的工具。为此，请单击列表并选择Virtualenv、Pipenv、Poetry或Conda。

       接下来，指定新虚拟环境的Location和Base 解释器。

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

       如果您想在 PyCharm 中创建 Python 解释器时重用此环境，请选中Make available to all projects复选框。

       配置基本解释器时，需要指定 Python 可执行文件的路径。如果 PyCharm 检测到您的机器上没有 Python，它会提供两个选项：从python.org下载最新的 Python 版本或指定 Python 可执行文件的路径（在非标准安装的情况下）。

       

     • 先前配置的解释器：如果已选择此选项，请从列表中选择所需的解释器，或者（如果未找到所需的解释器）单击并选择解释器。有关详细信息，请参阅配置 Python 解释器。

3. 单击Create后，PyCharm 会创建一个 Python 环境并安装fastapi和uvicorn包。它还添加了带有一些默认代码结构的main.py和test_main.http文件。

   

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

在开发 FastAPI 应用程序时，您可以从 IDE 中提供的编码帮助中受益。

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

  

• 您可以使用上下文感知代码完成来加快编码过程。只需开始输入代码结构，就会出现完成弹出窗口。您也可以按Ctrl+Space显示可用项目。

  

  

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

1. 创建新项目后，PyCharm 会为您提供运行/调试配置，以便您可以执行 FastAPI 应用程序。在可用的运行/调试配置列表中选择创建的配置。只需单击配置列表旁边的即可运行您的应用程序。

   

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

   

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

   

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

   

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

3. 您还可以执行.http文件来测试 GET 请求。您可以单独运行每个请求，也可以单击.http文件工具栏上的 在文件中运行所有请求链接以一次测试所有请求。

   选择一个选项以在默认环境或没有环境的情况下执行请求。

   

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

   

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

管理端点

1. 按Ctrl+Alt+S打开 IDE 设置并选择Plugins。

   在已安装选项卡中发现插件，并检查它是否已启用。如果那里不可用，请切换到Marketplace并安装它。

2. 选择查看 | 工具窗口 | Endpoints打开Endpoints工具窗口。

3. Endpoints工具窗口显示在 PyCharm 工具窗口的下部组中。它的左窗格列出了应用程序中定义的端点。

   

   右侧窗格显示相应 HTTP 客户端的文档和代码。

   双击端点列表中的任何项目以导航到.py文件中的相应方法。您还可以右键单击列表中的任何项目以获取上下文菜单，其中包含导航到源代码或查找端点用法的选项。

4. 使用编码辅助来创建和修改端点：

   • 代码完成

     当您在 Python 文件、HTTP 客户端和其他项目文件中键入端点名称时，PyCharm 会完成端点名称。

     

   • 实时模板

     使用可用于 HTTP 客户端的实时模板，您可以快速修改请求方法、URL 和变量。

     

   • 重构

     如果您需要重命名端点，请使用重命名重构。在编辑器中选择一个端点，按Shift+F6，然后键入其新名称。

     

     重命名发生在整个项目的所有事件中。

5. 您可以在编辑器的单独选项卡中预览 HTTP 客户端。单击在编辑器中打开，PyCharm 将使用 HTTP 请求打开一个临时临时文件。您可以单击装订线中的运行图标 ( ) 进行测试。