Endpoints tool window
View | Tool Windows | Endpoints
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.
To navigate to the endpoint declaration from the Endpoints tool window, do one of the following:
Select Jump to source from the endpoint's context menu.
Select the endpoint and press F4.
Double-click the endpoint.
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.
Endpoints marked as deprecated appear with a strikethrough (crossed out).
You can also search for endpoints in Search everywhere.
Press CtrlAlt0S to open settings and then select Advanced Settings.
Select the Show Endpoints tab for relevant projects checkbox.
You can now press CtrlShift0\ and, in the Endpoints tab, start typing a URL. The Endpoints tab is available in Spring, Micronaut, Quarkus, and Ktor projects.
IntelliJ IDEA 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+
Item | Description |
---|---|
Module | Filter endpoints by module or select an external module |
Type | Filter endpoints by type |
Framework | Filter endpoints by framework |
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 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. For more information, refer to Add a remote OpenAPI specification. | |
Show and hide the details panel | |
Configure the tool window layout and filters:
|
When you select an endpoint, you can see the details in the dedicated pane. Use or to show and hide the details pane.
Shows the generated HTTP or gRPC request for the selected endpoint.
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, refer to HTTP Client.
note
The tab is available if the OpenAPI Specifications plugin is installed and enabled.
For gRPC requests, the tab is not enabled because gRPC APIs are defined through .proto files.
Shows the generated OpenAPI specification for the selected endpoints.
You can also generate an OpenAPI specification for an entire module: right-click a module in the Endpoints tool window and select Export Draft of OpenAPI Specification.
To preview the specification in a separate file, click .
Provides examples of client code to access the selected endpoint. Use the Frameworks list to select a framework or a language in which you want to show code.
For Retrofit and Ktor, you can also click and select Show Boilerplate Code to complete the request sample with all the necessary code elements, such as import statements and HTTP Client instance.
To save the code sample into a file, hover over the code and click . This will save the code into a new scratch file.
Shows the documentation for the selected endpoint. Double-click an endpoint to navigate to its source code.
IntelliJ IDEA provides a diagram to show the interactions between microservices. In the Endpoints tool window, click .
Thanks for your feedback!