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 Endpoints tool window](https://resources.jetbrains.com/help/img/idea/2023.1/rm_endpoints_tool_window.png)
You can also navigate from the Endpoints tool window or from endpoint usages to the relevant endpoint declaration using the Go to Declaration action Control+B or Control+LeftClick.
In the Endpoints tool window, you can filter the list of endpoints by module, type, and framework. To list endpoints from external sources , select External under Module.
Endpoints marked as deprecated appear with a strikethrough (crossed out).
Toolbar
![Options of the Endpoints tool window Options of the Endpoints tool window](https://resources.jetbrains.com/help/img/idea/2023.1/rm_endpoints-tool-window-options.png)
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 | |
Configure the tool window layout and filters:
|
Endpoint details
When you select an endpoint, you can see the details in the right pane separated into tabs. Use to show and hide the details pane.
![Endpoints tool window: Documentation tab Endpoints tool window: Documentation tab](https://resources.jetbrains.com/help/img/idea/2023.1/rm_endpoints-tool-window-documentation.png)
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 Endpoints tool window: HTTP Client tab](https://resources.jetbrains.com/help/img/idea/2023.1/rm_endpoints-tool-window-http.png)