Manage Endpoints

note

Make sure the Endpoints plugin is enabled in the settings

You can preview, modify, create, and test endpoints of your Flask application.

1. Select View | Tool Windows | Endpoints to open the Endpoints tool window.

   Alternatively, click More tool windows on the left, and then select Endpoints.

2. The Endpoints tool window contains the list of endpoints defined in the application.

   The dedicated pane shows the details of the selected endpoint including the documentation, the generated HTTP requests, examples, and the generated OpenAPI specification.

   Double-click any endpoint in the list to navigate to its declaration. You can also right-click any item in the list to open the context menu.

   

• Code completion

  PyCharm completes endpoint names as you are typing them in Python files, HTTP clients, and other project files.

  

• Live templates

  With the live templates available for HTTP clients, you can quickly modify request methods, URLs, and variables.

  

• Refactoring

  If you need to rename an endpoint, use the Rename refactoring. Select an endpoint in the editor, press ShiftF6, and type its new name.

  

  Renaming happens in all occurrences across the project.

To open the HTTP client in a separate tab, click Open in Editor on the HTTP Client tab. PyCharm opens a temporary scratch file with the HTTP request. Use in the gutter to run the request.

Click the icon in the gutter to manage an endpoint.

You can find usages, test an endpoint by running the request in the HTTP Client, view all lower-level endpoints, navigate one level up, or copy the URL to the clipboard.