IntelliJ IDEA 2021.2 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.

Supported frameworks

IntelliJ IDEA recognizes endpoints from the following frameworks:

  • Jakarta EE WebSocket

  • Java EE WebSocket

  • JAX-WS

  • JAX-RS

  • JAX-RS Client

  • MicroProfile Rest Client

  • Spring Feign Client

  • Spring MVC

  • Spring Reactive WebSocket

  • Spring RestTemplate

  • Spring WS

  • Spring WebClient

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

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.

List options

Click The Options menu to select additional options.

Options of the Endpoints tool window
OptionDescription
Compact List ItemsShow only the endpoint addresses, without the type and framework.
Group by ModuleGroup endpoints from the same module together.
Show From LibrariesInclude endpoints defined in libraries.
Show From TestsInclude endpoints defined in tests.
Configure OpenAPI Sources

Add an external OpenAPI specification to include endpoints from this specification in the Endpoints tool window and highlight them with a yellow background. This also adds URLs defined in the specification to code completion.

For more information, see Add a remote OpenAPI specification.

Endpoint details

When you select an endpoint, you can see the details in the right pane separated into tabs.

Shows the definition of the selected endpoint with links to relevant code documentation.

Endpoints tool window: Documentation tab

Shows the generated HTTP 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 in IntelliJ IDEA code editor.

Endpoints tool window: HTTP Client tab

Shows a generated preview of the OpenAPI specification for the selected endpoints.

Endpoints tool window: OpenAPI tab

Click The Export Draft of OpenAPI Specification button to export the specification into a separate file.

Last modified: 02 August 2021