WebStorm 2025.1 Help

Endpoints 工具窗口

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

Endpoint 工具窗口

要从 端点 工具窗口导航到端点声明,请执行以下操作之一:

  • 请从终端的上下文菜单中选择 跳转到源

  • 请选择端点,然后按 F4

  • 双击端点。

从 Endpoint 工具窗口跳转到源代码

要搜索 Express 路由声明,请从主菜单转到 导航(N) | URL 映射 或按 Ctrl+Shift+\ ,然后从列表中选择相关声明。

查找 Express 路由声明

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

Endpoint 工具窗口:按模块筛选

标记为已弃用的端点会显示删除线(划去)。

开始之前

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

  • 要添加 端点 工具窗口,请在 设置 | 插件 页面的 Marketplace 选项卡上安装 Endpoints插件。

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

有关更多信息,请参阅 从 Marketplace 安装插件

工具栏

Endpoints 工具窗口的选项

条目

Description

模块

按照模块过滤端点或选择外部模块

类型

按类型过滤端点

框架

按框架过滤端点

配置 OpenAPI 源图标

配置 OpenAPI 源代码 :添加一个外部 OpenAPI 规范(例如,来自 SwaggerHub),以便在 端点 工具窗口中包含此规范中的端点,并用黄色背景突出显示它们。 在打开的 OpenAPI 规范 窗口中,点击 "添加"按钮 列表中的 远程规范 ,并指定 OpenAPI 规范文件的 URL 或在 SwaggerHub上查找 OpenAPI 规范。 这也将规范中定义的 URL 添加到 代码补全

Express 路由的补全建议

了解更多信息,请参阅 在 WebStorm 中使用 REST API

显示侧面板

显示和隐藏详细信息面板

配置工具窗口布局和筛选器:

  • 紧凑列表条目 :仅显示端点地址,不显示类型和框架。

  • 按模块分组 :将相同模块中的端点分组。

  • 显示库中的内容 :包含库中定义的端点。

  • 从测试显示 :包含在测试中定义的端点。

最后修改日期: 2025年 4月 22日