Endpoints tool window

If you are developing an Express application, you can get an overview of route handlers in the Endpoints tool window. The tool window can assist you when developing microservices and backend-frontend communication. It is also helpful for working with RESTful APIs.

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.

Jump to source from the Endpoint tool window

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

In the Endpoints tool window, you can filter the list of endpoints by module, type, and framework. To list endpoints from external sources (for example, from remote OpenAPI specifications), select External under Module.

Before you start

By default, the Endpoints tool window is not available in WebStorm.

To add the Endpoints tool window, install the Endpoints plugin on the Settings/Preferences | Plugins page, tab Marketplace.
To work with REST APIs, install the OpenAPI Specifications plugin (Settings/Preferences | Plugins page, tab Marketplace).

See Installing plugins from JetBrains repository for details.

List options

Click to select additional options.

Option	Description
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.
Configure OpenAPI Sources	Add an external OpenAPI specification to include endpoints from this specification in the Endpoints tool window and highlight them with a yellow background: open the Settings/Preferences dialog `Ctrl+Alt+S`, go to Languages & Frameworks \| OpenAPI Specifications, click 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. Learn more from Working with REST APIs in WebStorm.

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 in WebStorm code editor.

Shows a generated preview of the OpenAPI specification for the selected endpoints.

Last modified: 22 July 2021