Manage Endpoints

1. Make sure the Endpoints plugin is enabled in the settings. Press Ctrl+Alt+S to open the IDE settings and then select Plugins. Click the Installed tab. In the search field, type Endpoints. For more information about plugins, refer to Managing plugins.

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

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

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

   The dedicated pane shows the details of the selected endpotpoint 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.

   

4. Use coding assistance to create and modify endpoints:

   • 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 Shift+F6, and type its new name.

     

     Renaming happens in all occurrences across the project.

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

For more information, refer to Endpoints tool window.