端点工具窗口
最后修改时间:2023 年 9 月 6 日查看 | 工具窗口 | 端点
Endpoints工具窗口提供了项目中使用的 HTTP 和 WebSocket 协议的客户端和服务器 API 的聚合视图。该工具窗口可以在开发微服务和后端-前端通信时为您提供帮助。对于探索第三方 API 也很有帮助。
要从端点工具窗口导航到端点声明,请执行以下操作之一:
从端点的上下文菜单中选择转到声明。
选择端点并按。Ctrl0B
双击端点。
在端点工具窗口中,您可以按模块、类型和框架过滤端点列表。要列出来自外部源(例如,来自远程 OpenAPI 规范)的端点,请在“模块”下选择“外部”。
标记为已弃用的端点带有删除线(划掉)。
支持的框架
IntelliJ IDEA 可识别以下框架的端点:
雅加达 EE WebSocket
Java EE WebSocket
JAX-WS
JAX-RS
JAX-RS客户端
gRPC/Protobuf
MicroProfile Rest 客户端
Spring Feign 客户端
春季MVC
Spring 响应式 WebSocket
春季休息模板
春季WS
Spring Web客户端
Spring网络服务
Micronaut HTTP 控制器
Micronaut HTTP 客户端
Micronaut 管理端点
Micronaut WebSocket
克托尔
希利登议员
希利登SE
Quarkus
OpenAPI 3
招摇2
WSDL
改造2
OKHttp 3+
工具栏
物品 | 描述 |
---|---|
模块 | 按模块过滤端点或选择外部模块 |
类型 | 按类型过滤端点 |
框架 | 按框架过滤端点 |
配置 OpenAPI 源:添加外部 OpenAPI 规范(例如,来自 SwaggerHub)以在端点工具窗口中包含此规范中的端点,并以黄色背景突出显示它们。在打开的OpenAPI 规范窗口中,单击远程规范列表,然后指定 OpenAPI 规范文件的 URL 或在SwaggerHub上查找 OpenAPI 规范。这还将规范中定义的 URL 添加到代码补全中。 有关更多信息,请参阅添加远程 OpenAPI 规范。 | |
配置工具窗口布局和过滤器:
|
端点详细信息
选择端点后,您可以在专用窗格中查看详细信息。使用或显示和隐藏详细信息窗格。
显示所选端点的文档。双击端点以导航至其源代码。
笔记
如果安装并启用了OpenAPI 规范插件,则该选项卡可用。
对于gRPC请求,该选项卡未启用,因为 gRPC API 是通过 .proto 文件定义的。
显示为选定端点生成的 OpenAPI 规范。
You can also generate an OpenAPI specification for an entire module: right-click a module in the Endpoints tool window and select Export Draft of OpenAPI Specification.
To preview the specification in a separate file, click .
服务图
IntelliJ IDEA 提供了一个图表来展示微服务之间的交互。在端点工具窗口中,单击。
感谢您的反馈意见!