Skip to content

Quick Start

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

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

Released under the Apache-2.0 License.