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.
To navigate to the endpoint declaration 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.
To search for Express route declarations, go to
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.
Endpoints marked as deprecated appear with a strikethrough (crossed out).
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 | Plugins page, tab Marketplace.
To work with REST APIs, install the OpenAPI Specifications plugin (Settings | Plugins page, tab Marketplace).
For more information, refer to Install a plugin from Marketplace.
Toolbar
Item | Description |
---|---|
Module | Filter endpoints by module or select an external module |
Type | Filter endpoints by type |
Framework | Filter endpoints by framework |
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 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. | |
Show and hide the details panel | |
Configure the tool window layout and filters:
|