GoLand 2025.2 Help

Endpoints 工具窗口

端点 工具窗口提供了项目中用于 HTTP 和 WebSocket 协议的客户端与服务器 API 的汇总视图。 该工具窗口可协助开发微服务和后端与前端之间的通信。 该工具窗口也有助于探索第三方 API。

Endpoints 工具窗口

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

  • 从 endpoint 的上下文菜单中选择 跳转至源代码

  • 选择 endpoint 并按下 F4

  • 双击 endpoint。

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

Endpoint 工具窗口:按模块筛选

已标记为已弃用的 endpoint 会显示为删除线形式。

支持的框架

GoLand 能识别以下框架中的 endpoint:

  • Jakarta EE WebSocket

  • Java EE WebSocket

  • JAX-WS

  • JAX-RS

  • JAX-RS Client

  • gRPC/Protobuf

  • MicroProfile Rest Client

  • Spring Feign Client

  • Spring MVC

  • Spring Reactive WebSocket

  • Spring RestTemplate

  • Spring WS

  • Spring WebClient

  • Spring Web Services

  • Micronaut HTTP Controllers

  • Micronaut HTTP Client

  • Micronaut Management Endpoints

  • Micronaut WebSocket

  • Ktor

  • Helidon MP

  • Helidon SE

  • Quarkus

  • OpenAPI 3

  • Swagger 2

  • WSDL

  • Retrofit 2

  • OkHttp 3+

工具栏

Endpoints 工具窗口的选项

项目

描述

模块

按模块筛选 endpoint 或选择外部模块

类型

按类型筛选 endpoint

框架

按框架筛选 endpoint

配置 OpenAPI 源图标

配置 OpenAPI 源 :添加外部 OpenAPI 规范(例如 SwaggerHub),以在 端点 工具窗口中包含此规范中的 endpoint,并使用黄色背景突出显示。 在打开的 OpenAPI 规范 窗口中,在 远程规范 列表中点击 添加按钮 ,然后输入 OpenAPI 规范文件的 URL,或在 SwaggerHub 上查找规范。 这还会将规范中定义的 URL 添加到 代码补全 中。

显示侧边面板

显示或隐藏详细信息面板

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

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

  • 按模块分组 :将来自同一模块的 endpoint 分组。

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

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

Endpoint 详细信息

当您选择一个 endpoint 时,您可以在专用窗格中查看详细信息。 使用 显示侧边面板图标 来显示或隐藏详细信息面板。

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

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

Endpoints 工具窗口:HTTP Client 选项卡

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

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

Endpoints 工具窗口:OpenAPI 选项卡

要在单独的文件中 预览规范 ,请点击 导出 OpenAPI 规范草稿按钮

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

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