If you are developing a Django, FastAPI, or Flask application, you can get an overview of all declared URLs and endpoints in the Endpoints tool window. The tool window can assist you when developing microservices and backend-frontend communication. It is also helpful for working with RESTful APIs.
For information on using the Endpoints tool window with specific frameworks, refer to the following pages:
To navigate to the endpoint declaration from the Endpoints tool window, do one of the following:
Select Jump to source from the endpoint's context menu.
Select the endpoint and press F4.
Double-click the endpoint.
To search for endpoint declarations, go to Navigate | URL Mapping from the main menu or press CtrlShift0\ and select the relevant declaration from the list.
In the Endpoints tool window, you can filter the list of endpoints by module, type, and framework.
note
For Django, the list contains the endpoints that comply with the following requirements:
The name of the file where the endpoint has been declared contains url.
The endpoint has been declared within a urlpatterns variable.
The endpoint has been declared by using either path or re_path function.
The endpoint declaration contains a reference to either a class-based or a function-based view.
Configure OpenAPI Sources: Add an external OpenAPI specification (for example, from SwaggerHub) to include endpoints from this specification in the Endpoints tool window and highlight them with a yellow background. In the OpenAPI Specifications window that opens, click in the Remote Specifications list, and specify the URL of an OpenAPI specification file or find an OpenAPI specification on SwaggerHub. This also adds URLs defined in the specification to code completion.
Compact List Items: Show only the endpoint addresses, without the type and framework.
Group by Module: Group endpoints from the same module.
Show From Libraries: Include endpoints defined in libraries.
Show From Tests: Include endpoints defined in tests.
Endpoint details
When you select an endpoint, you can see the details in the dedicated pane. Use or to show and hide the details pane.
HTTP Client
OpenAPI
Documentation
Shows the generated HTTP request for the selected endpoint.
Django URL parameters are enclosed in double curly braces.
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, refer to HTTP Client.
note
For gRPC requests, the tab is not enabled because gRPC APIs are defined through .proto files.
Shows the generated OpenAPI specification for the selected endpoints.
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 .
Shows the documentation for the HTTP method in the referenced class, function, or method.
Our website uses some cookies and records your IP address for the purposes of accessibility, security, and managing your access to the telecommunication network. You can disable data collection and cookies by changing your browser settings, but it may affect how this website functions. Learn more.
With your consent, JetBrains may also use cookies and your IP address to collect individual statistics and provide you with personalized offers and ads subject to the Privacy Notice and the Terms of Use. JetBrains may use third-party services for this purpose. You can adjust or withdraw your consent at any time by visiting the Opt-Out page.