WebStorm 2021.1 Help

端点工具窗口

如果您正在开发Express应用程序,您可以在Endpoints工具窗口中获得路由处理程序的概述。工具窗口可以在开发微服务和后端-前端通信时为您提供帮助。它对于使用 RESTful API也很有帮助。

端点工具窗口

您还可以使用Go to Declaration操作或从Endpoints工具窗口或从端点使用导航到相关的端点声明。Ctrl+BCtrl+Click

从 Endpoint 工具窗口跳转到源

要搜索 Express 路线声明,请转到导航 | URL 映射...从主菜单或按Ctrl+Shift+\ 并从列表中选择相关声明。

查找快递路线申报

端点工具窗口中,您可以按模块、类型和框架过滤端点列表。要列出来自外部源(例如,来自远程 OpenAPI 规范)的端点,请在Module下选择External

端点工具窗口:按模块过滤

在你开始前

默认情况下,端点工具窗口在 WebStorm 中不可用。

  • 要添加Endpoints工具窗口,请在Settings/Preferences |上安装Endpoints插件。插件页面,选项卡Marketplace

  • 要使用 REST API,请安装OpenAPI 规范插件(设置/首选项 | 插件页面,选项卡Marketplace)。

有关详细信息,请参阅从 JetBrains 存储库安装插件

列出选项

单击选项菜单以选择其他选项。

端点工具窗口的选项

选项

描述

精简列表项

仅显示端点地址,不显示类型和框架。

按模块分组

将来自同一模块的端点组合在一起。

从库中显示

包括在库中定义的端点。

从测试中显示

包括在测试中定义的端点。

配置 OpenAPI 源

添加外部 OpenAPI 规范以在端点工具窗口中包含此规范中的端点,并用黄色背景突出显示它们:打开设置/首选项对话框 ( Ctrl+Alt+S),转到语言和框架 | OpenAPI Specifications添加按钮,单击Remote Specifications列表,并指定 OpenAPI 规范文件的 URL 或在 SwaggerHub 上查找 OpenAPI规范。这还将规范中定义的 URL 添加到代码完成中。

快速路线的完成建议

从在 WebStorm 中使用 REST API了解更多信息。

服务图

WebStorm 提供了一个图表来显示微服务之间的交互。在端点工具窗口中,单击服务图表按钮

服务图
最后修改:2022 年 1 月 19 日