RubyMine 2022.3 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. 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 Ctrl+B or Ctrl+Click.

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.

List options

Click The Options menu to select additional options.

Options of the Endpoints tool window



Compact List Items

Show only the endpoint addresses, without the type and framework.

Group by Module

Group endpoints from the same module together.

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.

Endpoints tool window: Documentation tab

Shows the generated HTTP 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
Last modified: 29 September 2022