Endpoints tool window
The Endpoints tool window provides an aggregated view of both client and server APIs used in your project for HTTP and WebSocket protocols. The tool window can assist you when developing microservices and backend-frontend communication. It is also helpful for exploring third-party APIs.
IntelliJ IDEA recognizes endpoints from the following frameworks:
Jakarta EE WebSocket
Java EE WebSocket
MicroProfile Rest Client
Spring Feign Client
Spring Reactive WebSocket
Micronaut HTTP Controllers
Micronaut HTTP Client
Micronaut Management Endpoints
You can also navigate from the Endpoints tool window or from endpoint usages to the relevant endpoint declaration using the Go to Declaration action Ctrl+B or Ctrl+Click.
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.
Click to select additional options.
|Compact List Items||Show only the endpoint addresses, without the type and framework.|
|Group by Module||Group endpoints from the same module together.|
|Show From Libraries||Include endpoints defined in libraries.|
|Show From Tests||Include endpoints defined in tests.|
|Configure OpenAPI Sources|
Add an external OpenAPI specification to include endpoints from this specification in the Endpoints tool window and highlight them with a yellow background. This also adds URLs defined in the specification to code completion.
For more information, see Add a remote OpenAPI specification.
When you select an endpoint, you can see the details in the right pane separated into tabs.
Shows the definition of the selected endpoint with links to relevant code documentation.
Shows the generated HTTP requests for the selected endpoints.
If the corresponding server is running, you can submit the request to see the response immediately or open it in a separate HTTP requests file in the editor. For more information, see HTTP client in IntelliJ IDEA code editor.
Shows a generated preview of the OpenAPI specification for the selected endpoints.
Click to export the specification into a separate file.