Pycharm
 
2023.3
快捷方式：Windows
获取 PyCharm
  1. 参考
  2. 工具窗口参考
  3. 端点工具窗口

端点工具窗口

最后修改时间：2023 年 11 月 7 日

所需插件：端点

查看 | 工具窗口 | 端点

如果您正在开发Django应用程序或基于Django REST Framework或FastAPI 的API，您可以在Endpoints工具窗口中获取所有声明的 URL 和端点的概述。该工具窗口可以在开发微服务和后端-前端通信时为您提供帮助。它对于使用 RESTful API也很有帮助。

端点工具窗口

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

  • 选择 从端点的上下文菜单跳转到源。

  • 选择端点并按 。F4

  • 双击端点。

从 Endpoint 工具窗口跳转到源

要搜索端点声明，请转至导航| 从主菜单中进行 URL 映射或按并从列表中选择相关声明。CtrlShift0\

查找快速路线声明

在端点工具窗口中，您可以按模块、类型和框架过滤端点列表。

端点工具窗口：按模块过滤

笔记

对于 Django，该列表包含符合以下要求的端点：

  • 声明端点的文件的名称包含url.

  • 端点已在urlpatterns变量中声明。

  • 端点已使用pathorre_path函数声明。

  • 端点声明包含对基于类或基于函数的视图的引用。

警告

目前不支持以下内容：

有关更多信息，请参阅PY-61871。

要浏览库文件中声明的端点，请单击App客户端expui一般检查检查眼睛，然后选择“显示从库”。

标记为已弃用的端点带有删除线（划掉）。

工具栏

物品

描述

模块

按模块过滤端点或选择外部模块

类型

按类型过滤端点

框架

按框架过滤端点

配置 OpenAPI 源图标

笔记

如果安装并启用了OpenAPI 规范插件，则该操作可用。

配置 OpenAPI 源：添加外部 OpenAPI 规范（例如，来自 SwaggerHub）以在端点工具窗口中包含此规范中的端点，并以黄色背景突出显示它们。在打开的OpenAPI 规范添加按钮窗口中，单击远程规范列表，然后指定 OpenAPI 规范文件的 URL 或在SwaggerHub上查找 OpenAPI 规范。这还将规范中定义的 URL 添加到代码补全中。

了解更多信息在 PyCharm 中使用 REST API。

App客户端expui一般检查检查眼睛

配置工具窗口布局和过滤器：

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

  • 按模块分组：对来自同一模块的端点进行分组。

  • 显示来自库：包括库中定义的端点。

  • Show From Tests：包括测试中定义的端点。

端点详细信息

选择端点后，您可以在专用窗格中查看详细信息。使用显示侧面板图标或App客户端expui总预览垂直显示和隐藏详细信息窗格。

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

Django URL 参数包含在双花括号中。

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

端点工具窗口：HTTP 客户端选项卡