Endpoints 工具窗口
如果您正在开发的应用程序使用 Django、 FastAPI 或 Flask ,您可以在 端点 工具窗口中查看所有已声明的 URL 和端点的概览。 该工具窗口可帮助您开发微服务以及后端与前端之间的通信。 它对于 使用 RESTful API 也很有帮助。

有关在特定框架中使用 端点 工具窗口的信息,请参阅以下页面:
要从 端点 工具窗口导航到端点声明,请执行以下任一操作:
在端点的上下文菜单中选择 跳转到源代码。
选择端点并按 F4。
双击该端点。

要搜索端点声明,请在主菜单中转到 ,或按 Ctrl+Shift+\ ,然后从列表中选择相关声明。

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

要查看在库文件中声明的端点,点击 ,然后选择 显示库中的内容。
标记为已弃用的端点将以删除线显示(划掉)。
工具栏
项 | 说明 |
|---|---|
模块 | 按应用筛选端点,或选择外部应用 |
类型 | 按类型筛选端点 |
框架 | 按框架筛选端点 |
配置 OpenAPI 源 :添加外部 OpenAPI 规范(例如来自 SwaggerHub),以在 端点 工具窗口中包含该规范中的端点,并以黄色背景高亮显示它们。 在打开的 OpenAPI 规范 窗口中,点击 详细了解请参阅 在 PyCharm 中使用 REST API。 | |
显示和隐藏详细信息面板 | |
配置工具窗口布局和筛选器:
|
端点详细信息
选择端点时,您可以在专用面板中查看详细信息。 使用 或
显示和隐藏详细信息面板。
显示为所选端点生成的 HTTP 请求。
Django URL 参数用双花括号括起。
如果对应的服务器正在运行,您可以点击 提交请求 立即查看响应,或点击 在编辑器中打开 在编辑器中的单独 HTTP 请求文件中对其进行编辑。 有关更多信息,请参阅 HTTP 客户端。

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

要在单独的文件中 预览该规范 ,请点击 。
显示引用的类、函数或方法中的 HTTP 方法文档。

提供访问所选端点的客户端代码示例。 使用 框架 列表选择要显示代码的框架或语言。

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