Endpoints tool window

If you are developing a Django application or an API based on Django REST Framework or FastAPI, 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.

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.

Jump to source from the Endpoint tool window

To search for endpoint declarations, go to Navigate | URL Mapping from the main menu or press Command Shift \ 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.

To explore the endpoints declared in library files, click , and then select Show From Libraries.

Endpoints marked as deprecated appear with a strikethrough (crossed out).

Toolbar

Item	Description
Module	Filter endpoints by module or select an external module
Type	Filter endpoints by type
Framework	Filter endpoints by framework
	The action is available if the OpenAPI Specifications plugin is installed and enabled. 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. Learn more from Working with REST APIs in PyCharm.
	Configure the tool window layout and filters: 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.

Shows the documentation for the HTTP method in the referenced class, function, or method.

Endpoints tool window: Documentation tab

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.

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 .

Last modified: 06 September 2023