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

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

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

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

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

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

要在单独的文件中 预览规范 ,请点击 。
提供客户端代码示例以访问选定的端点。 请使用 框架 列表选择您希望展示代码的框架或语言。

要将代码示例保存到文件中,请将鼠标悬停在代码上,然后点击 。 这会将代码保存到新的临时文件中。
显示引用类、函数或方法中 HTTP 方法的文档。
