RubyMine 2024.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.

Endpoints tool window

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.

  • Double-click the endpoint.

Jump to source from the Endpoint tool window

To search for endpoint declarations, go to Navigate | URL Mapping from the main menu or press Ctrl+Shift+\ and select the relevant declaration from the list.

Find Express route declaration

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).


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.

Show Side Panel

Show and hide the details panel

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 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.

Endpoints tool window: HTTP Client tab

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

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

Shows the actual route element that declares the endpoint.

Endpoints tool window: Documentation tab
Last modified: 26 April 2024