IntelliJ IDEA 2025.1 Help

Endpoints(端点)工具窗口

端点 工具窗口提供了项目中使用的 HTTP 和 WebSocket 协议的客户端和服务器 API 的汇总视图。 此工具窗口可以在开发微服务和后端-前端通信时为您提供帮助。 它对于探索第三方 API 也很有帮助。

Endpoints(端点)工具窗口

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

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

  • 请选择端点,然后按 F4

  • 双击端点。

端点 工具窗口中,您可以按模块、类型和框架筛选端点列表。 要列出外部来源的端点(例如,来自 远程 OpenAPI 规范 ),请选择 外部 下的 模块

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

在 Search Everywhere 中启用 Endpoints 选项卡

您还可以在 随处搜索 中搜索端点。

  1. Ctrl+Alt+S 打开设置,然后选择 高级设置

  2. 请选择 显示相关项目的“端点”标签页 复选框。

在 Search Everywhere 中启用 Endpoints

现在,您可以按 Ctrl+Shift+\ ,并在 端点 选项卡中开始输入 URL。 在 Spring、Micronaut、Quarkus 和 Ktor 项目中都可以使用 端点 选项卡。

在任何地方搜索的端点

支持的框架

IntelliJ IDEA 识别以下框架的端点:

  • Jakarta EE WebSocket

  • Java EE WebSocket

  • JAX-WS

  • JAX-RS

  • JAX-RS 客户端

  • gRPC/Protobuf

  • MicroProfile Rest Client

  • Spring Feign 客户端

  • Spring MVC

  • Spring Reactive WebSocket

  • Spring RestTemplate

  • Spring WS

  • Spring WebClient

  • Spring Web Services

  • Micronaut HTTP 控制器

  • Micronaut HTTP 客户端

  • Micronaut 管理端点

  • Micronaut WebSocket

  • Ktor

  • Helidon MP

  • Helidon SE

  • Quarkus

  • OpenAPI 3

  • Swagger 2

  • WSDL

  • Retrofit 2

  • OkHttp 3+

工具栏

条目

描述

模块

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

类型

按类型过滤端点

框架

按框架过滤端点

配置 OpenAPI 源图标

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

有关更多信息,请参见 添加远程 OpenAPI 规范

服务图标

服务图

显示侧面板

显示和隐藏详细信息面板

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

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

  • 按模块分组 :将相同模块中的端点分组。

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

  • 从测试显示 :包含在测试中定义的端点。

端点详情

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

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

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

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

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

您还可以为整个模块生成 OpenAPI 规范:在 端点 工具窗口中右键点击一个模块并选择 导出OpenAPI 规范的草稿

Endpoints 工具窗口:OpenAPI 选项卡

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

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

对于 Retrofit 和 Ktor,您还可以点击 显示图标 并选择 显示样板代码 来完成包含所有必要代码元素(如 import 声明和 HTTP 客户端 实例)的请求示例。

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

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

显示所选端点的文档。 双击端点以导航到其源代码。

终端工具窗口:文档选项卡

服务关系图

IntelliJ IDEA 提供一个图表以展示微服务之间的交互。 在 端点 工具窗口中,点击 服务图标

服务图
最后修改日期: 2025年 4月 24日