PyCharm 2025.2 Help

Endpoints 工具窗口

如果您正在开发的应用使用了 DjangoFastAPIFlask ,那么可以在 端点 工具窗口中查看所有已声明的 URL 和端点的概览。 此工具窗口可以在开发微服务和后端-前端通信时为您提供帮助。 它对于 使用 RESTful API也很有帮助。

Endpoint 工具窗口

有关在特定框架中使用 端点 工具窗口的信息,请参阅以下页面:

要从 端点 工具窗口导航到端点声明,请执行以下操作之一:

  • 请从终端的上下文菜单中选择 跳转到源

  • 请选择端点,然后按 F4

  • 双击端点。

从 Endpoints 工具窗口跳转到源代码

要搜索端点声明,请从主菜单转到 导航(N) | 端点 或按 Ctrl+Shift+\ 并从列表中选择相关声明。

查找路由声明

端点 工具窗口中,您可以按应用程序、类型和框架筛选端点列表。

Endpoint 工具窗口:按框架筛选

要浏览库文件中声明的端点,请点击 ,然后选择 显示库中的内容

标记为已弃用的端点会显示删除线(划去)。

工具栏

项目

描述

模块

按应用程序筛选端点或选择外部应用程序

按类型分组

按类型过滤端点

框架

按框架过滤端点

配置 OpenAPI 源图标

配置 OpenAPI 源 :添加一个外部 OpenAPI 规范(例如,来自 SwaggerHub),以便在 端点 工具窗口中包含此规范中的端点,并用黄色背景突出显示它们。 在打开的 OpenAPI 规范 窗口中,点击 添加按钮 列表中的 远程规范 ,并指定 OpenAPI 规范文件的 URL 或在 SwaggerHub上查找 OpenAPI 规范。 这也将规范中定义的 URL 添加到 代码补全

了解更多信息,请参阅 在 PyCharm 中使用 REST API

显示侧边面板

显示和隐藏详细信息面板

配置工具窗口布局和筛选器:

  • 紧凑列表项 :仅显示端点地址,不显示类型和框架。

  • 按应用分组 :将同一应用程序中的端点分组。

  • 显示来自库的内容 :包含库中定义的端点。

  • 显示来自测试的内容 :包含在测试中定义的端点。

端点详情

当您选择一个端点时,您可以在专用窗格中看到详细信息。 使用 显示侧边栏图标 显示和隐藏详细信息窗格。

显示为所选端点生成的 HTTP 请求。

Django URL 参数用双大括号括起来。

如果相应的服务器正在运行,您可以提交请求以立即查看响应,或在编辑器中将其打开在单独的 HTTP 请求文件中。 有关更多信息,请参阅 HTTP 客户端

Endpoints 工具窗口:HTTP 客户端 选项卡

显示所选端点生成的 OpenAPI 规范。

Endpoints 工具窗口:OpenAPI 选项卡

要在单独的文件中 预览规范 ,请点击 “OpenAPI Specification 更多”按钮

提供客户端代码示例以访问选定的端点。 请使用 框架 列表选择您希望展示代码的框架或语言。

端点工具窗口:示例选项卡

要将代码示例保存到文件中,请将鼠标悬停在代码上,然后点击 保存图标。 这会将代码保存到新的临时文件中。

显示引用类、函数或方法中 HTTP 方法的文档。

终端工具窗口:文档选项卡
最后修改日期: 2025年 9月 26日