# Endpoints tool window

> For the complete documentation index, see [llms.txt](https://www.jetbrains.com/help/ruby/2026.3/llms.txt).

> **TL;DR**
> `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.

![Endpoints tool window](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints_tool_window.png)

To navigate to the endpoint declaration in `routes.rb` 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` (Windows), `⌘ ↓` (macOS), `F4` (IntelliJ IDEA Classic (macOS)), `F4` (macOS System Shortcuts), `F4` (XWin), `F4` (GNOME), `F4` (KDE), `F4` (Emacs), `F4` (Sublime Text), `F4` (Sublime Text (macOS)), `F4` (Visual Studio), `⌘ ↓` (Visual Studio (macOS)), `F4` (TextMate), `F4` (NetBeans), `F12` (Eclipse), `F3` (Eclipse (macOS)).

* Double-click the endpoint.

![Jump to source from the Endpoint tool window](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints_tool_window_jump_to_source.png)

To search for endpoint declarations, go to `Navigate | URL Mapping` from the main menu or press `Ctrl+Shift+\` (Windows), `⌘ ⇧ \` (macOS), `⌘ ⇧ \` (IntelliJ IDEA Classic (macOS)), `⌘ ⇧ \` (macOS System Shortcuts), `Ctrl+Shift+\` (XWin), `Ctrl+Shift+\` (GNOME), `Ctrl+Shift+\` (KDE), `Ctrl+Shift+\` (Emacs), `Ctrl+Shift+\` (Sublime Text), `⌘ ⇧ \` (Sublime Text (macOS)), `Ctrl+Shift+\` (Visual Studio), `⌘ ⇧ \` (Visual Studio (macOS)), `Meta+Shift+\` (TextMate), `Ctrl+Shift+\` (NetBeans), `Ctrl+Shift+\` (Eclipse), `⌘ ⇧ \` (Eclipse (macOS)) and select the relevant declaration from the list.

![Find Express route declaration](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints_find_router.png)

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](https://resources.jetbrains.com/help/img/idea/2026.3/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 |
| ![the Configure OpenAPI Sources icon](https://resources.jetbrains.com/help/img/idea/2026.3/product.icons.expui.openApi.svg) |    > **Note:** > The action is available if the [OpenAPI Specifications](https://plugins.jetbrains.com/plugin/14394-openapi-specifications) plugin is installed and enabled.      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](https://resources.jetbrains.com/help/img/idea/2026.3/app.expui.general.add.svg) in the Remote Specifications list, and specify the URL of an OpenAPI specification file or find an OpenAPI specification on [SwaggerHub](https://app.swaggerhub.com/). This also adds URLs defined in the specification to [code completion](auto-completing-code.html).                                                  |
|  ![Show Side Panel](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.previewHorizontally.svg)  |  Show and hide the details panel  |
|  ![](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.show.svg)  |    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 dedicated pane. Use ![the Show Side Panel icon](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.previewHorizontally.svg) or ![](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.previewVertically.svg) to show and hide the details pane.

HTTP Client:

Shows the generated HTTP or [gRPC](http-client-in-product-code-editor.html#grpc-requests)  request for the selected endpoint.

You can edit the generated request, for example, to add a header that is not declared in the code. RubyMine remembers your changes for each endpoint and restores them the next time you select the endpoint, including after you restart the IDE.

If the corresponding server is running, you can click Submit Request to see the response immediately or Open in Editor to edit it in a separate HTTP requests file in the editor. For more information, refer to [HTTP Client](http-client-in-product-code-editor.html).

![Endpoints tool window: HTTP Client tab](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints-tool-window-http.png)

OpenAPI:

> **Note:**
> The tab is available if the [OpenAPI
> Specifications](https://plugins.jetbrains.com/plugin/14394-openapi-specifications) plugin is installed and enabled.
>
>
>
> For [gRPC](http-client-in-product-code-editor.html#grpc-requests) 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.

![Endpoints tool window: OpenAPI tab](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints-tool-window-openapi.png)

To [preview the specification](openapi.html#preview-api) in a separate file, click ![The Export Draft of OpenAPI Specification button](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.save.svg).

Documentation:

Shows the actual route element that declares the endpoint.

![Endpoints tool window: Documentation tab](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints-tool-window-documentation.png)

Examples:

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 ![the Show icon](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.show.svg) and select Show Boilerplate Code to complete the request sample with all the necessary code elements, such as import statements and HTTP Client instance.

![Endpoints tool window: Example tab](https://resources.jetbrains.com/help/img/idea/2026.3/rm_endpoints_client_examples.png)

To save the code sample into a file, hover over the code and click ![Save icon](https://resources.jetbrains.com/help/img/idea/2026.3/app-client.expui.general.save.svg). This will save the code into a new scratch file.

## How it works

* [View all endpoints defined in your OpenAPI specification](openapi.html)

* [Create an HTTP request to an endpoint](http-client-in-product-code-editor.html#create-http-request-to-endpoint)

* [Generate a gRPC request from Endpoints tool window](http-client-in-product-code-editor.html#generate_a_grpc_request_from_endpoints_tool_window)

## See also

