Endpoints tool window

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:

• Manage Django Endpoints

• Manage FastAPI Endpoints

• Manage Flask Endpoints

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 .

• Double-click the endpoint.

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

warning

The following is NOT supported at the moment:

• URLs declared by using the include() function

• URLs that point to views decorated with login_required()

For more information, refer to PY-61871.

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).

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.