Usage

This guide walks you through the basic workflow of using EasyApi.

Export APIs to Postman

1. Open a Java/Kotlin file containing API endpoints (e.g., a Spring @RestController)
2. Right-click in the editor and select EasyApi > ExportToPostman
3. The API definitions will be exported to your Postman collection

Export APIs to Markdown

1. Open a Java/Kotlin file containing API endpoints
2. Right-click in the editor and select EasyApi > ExportMarkdown
3. A Markdown document will be generated with all API details

Export Only Selected Methods

Since v3.1.6, EasyApi respects method-level selection when exporting. Select one or more methods in the editor (either by caret or by selecting a text range that spans them) before triggering an export — only the endpoints whose source method matches (or overrides) the selection are exported, instead of every endpoint in the containing class.

This works for every export channel (Postman, Markdown, cURL, HttpClient, Hoppscotch). If no methods are selected, the whole containing class is exported as before.

Call an API

1. Open a Java/Kotlin file containing API endpoints
2. Click the gutter icon (▶) next to an API method, or right-click > EasyApi > Call
3. The API Dashboard opens with the endpoint details pre-populated
4. Modify parameters as needed and click Send

Next Steps

• Export to Postman — Detailed Postman export options
• Export to Markdown — Customize Markdown output format
• Call API — Dashboard features, request editing, and Search Everywhere
• Configuration — Configure EasyApi behavior