GoLand 2023.1 Help

Endpoints tool window

The Endpoints tool window provides an aggregated view of both client and server APIs used in your project for HTTP and WebSocket protocols. The tool window can assist you when developing microservices and backend-frontend communication. It is also helpful for exploring third-party APIs.

Endpoints tool window

You can also navigate from the Endpoints tool window or from endpoint usages to the relevant endpoint declaration using the Go to Declaration action Ctrl+B or Ctrl+Click.

In the Endpoints tool window, you can filter the list of endpoints by module, type, and framework. To list endpoints from external sources (for example, from remote OpenAPI specifications), select External under Module.

Endpoint tool window: filter by module

Supported frameworks

GoLand recognizes endpoints from the following frameworks:

  • 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+


Options of the Endpoints tool window




Filter endpoints by module or select an external module


Filter endpoints by type


Filter endpoints by framework

the Configure OpenAPI Sources icon

Configure OpenAPI Sources: Add an external OpenAPI specification (for example, from SwaggerHub) to include endpoints from this specification in the Endpoints tool window and highlight them with a yellow background. In the OpenAPI Specifications window that opens, click the Add button in the Remote Specifications list, and specify the URL of an OpenAPI specification file or find an OpenAPI specification on SwaggerHub. This also adds URLs defined in the specification to code completion.

the Options icon

Configure the tool window layout and filters:

  • Compact List Items: Show only the endpoint addresses, without the type and framework.

  • Group by Module: Group endpoints from the same module.

  • Show From Libraries: Include endpoints defined in libraries.

  • Show From Tests: Include endpoints defined in tests.

Endpoint details

When you select an endpoint, you can see the details in the right pane separated into tabs. Use the Show Side Panel icon to show and hide the details pane.

Shows the documentation for the selected endpoint. Double-click an endpoint to navigate to its source code.

Endpoints tool window: Documentation tab

Shows the generated HTTP or gRPC requests for the selected endpoints.

If the corresponding server is running, you can submit the request to see the response immediately or open it in a separate HTTP requests file in the editor. For more information, see HTTP Client.

Endpoints tool window: HTTP Client tab

Shows the generated OpenAPI specification for the selected endpoints.

Endpoints tool window: OpenAPI tab

To preview the specification in a separate file, click The Export Draft of OpenAPI Specification button.

Last modified: 20 April 2023