Endpoints 工具窗口
如果您正在开发的应用使用了 Express、 Next.js 或 GraphQL ,可以在 端点 工具窗口中查看路由处理程序的概览。 该工具窗口可在开发微服务及前后端通信过程中为您提供帮助。 它对于探索第三方 API 也非常有用。

要从 端点 工具窗口导航到 endpoint 声明,请执行以下操作之一:
从该 endpoint 的上下文菜单中选择 跳转到源代码。
选择该 endpoint 并按下 F4。
双击该 endpoint。

在 端点 工具窗口中,您可以按模块、类型和框架筛选 endpoint 列表。 要列出来自外部源的 endpoint,请在 模块 下选择 外部。

被标记为已弃用的 endpoint 将以删除线格式显示。
在“全部搜索”中启用 Endpoints 选项卡
您也可以在 按名称搜索目标(全局搜索) 中搜索 endpoint。
按下 Ctrl+Alt+S 打开设置,然后选择 。
选中 显示相关项目的“端点”标签页为相关项目显示 Endpoints 选项卡 复选框。

此时,您可以按下 Ctrl+Shift+\ ,并在 Endpoints 选项卡中开始输入 URL。

开始之前
默认情况下, 端点 工具窗口在 WebStorm 中不可用。
要添加 端点 工具窗口,请在 设置|插件 页面、 Marketplace 选项卡中安装 Endpoints 插件。
要使用 REST API,请安装 OpenAPI Specifications 插件(设置|插件 页面, Marketplace 选项卡)。
有关更多信息,请参阅 从 Marketplace 安装插件。
工具栏

条目 | 说明 |
|---|---|
模块 | 按模块筛选 endpoint,或选择外部模块 |
类型 | 按类型筛选 endpoint |
框架 | 按框架筛选 endpoint |
配置 OpenAPI 源 :添加外部 OpenAPI 规范(例如来自 SwaggerHub),将该规范中的 endpoint 包含在 端点 工具窗口中,并以黄色背景标识。 在打开的 OpenAPI 规范 窗口中,点击 ![]() 了解更多信息,请参阅 在 WebStorm 中使用 REST API。 | |
显示和隐藏详情面板 | |
配置工具窗口的布局和筛选条件:
|
Endpoint 详情
当您选择一个 endpoint 时,您可以在专用窗格中查看详情。 使用 或
可显示或隐藏详情面板。
显示所选 endpoint 生成的 HTTP 或 gRPC 请求。
如果相关服务器正在运行,您可以提交该请求以立即查看响应,或在编辑器中将其打开为单独的 HTTP 请求文件。 如需了解更多信息,请参阅 HTTP 客户端。

显示所选端点的生成 OpenAPI 规范。
您还可以为整个模块生成 OpenAPI 规范:在 端点 工具窗口中右键单击某个模块,然后选择 导出OpenAPI 规范的草稿。

如需在单独的文件中 预览规范 ,请单击 。
提供访问所选端点的客户端代码示例。 使用 框架 列表选择要显示代码的框架或语言。
对于 Retrofit 和 Ktor,您还可以单击 并选择 显示样板代码 ,以使用所有必要的代码元素(例如 import 语句和 HTTP Client 实例)完成请求示例。

要将代码示例保存到文件中,请将鼠标悬停在代码上方,然后单击 。 这会将代码保存到新的临时文件中。
显示所选端点的文档。 双击某个端点即可导航至其源代码。

