RubyMine
 
2023.1
Shortcuts: Windows
Get RubyMine
You are viewing the documentation for an earlier version of RubyMine.
  1. Reference
  2. Tool Windows Reference
  3. Endpoints tool window

Endpoints tool window

Last modified: 21 June 2023

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.

Endpoints tool window

You can also navigate from the Endpoints tool window or from endpoint usages to the relevant endpoint declaration using the Go to Declaration action Ctrl0B or CtrlClick.

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

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

note

The action is available if the 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 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.

the Options icon

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 right pane separated into tabs. Use the Show Side Panel icon to show and hide the details pane.

Endpoints tool window: Documentation tab