Skip to content

Usage

EasyYapi supports the following usage methods:

Method 1: Export via Shortcut

  1. Open a file containing APIs in your project, or select files/folders in the IDEA project panel
  2. Use shortcut Alt + Shift + E (Windows/Linux) or Ctrl + E (macOS)
  3. Select the APIs to export
  4. Choose the export channel: YApi / Markdown / Postman
  5. Click the ✔ button or press Enter to complete the export

Method 2: Export via Right-Click

  1. Open a file containing APIs in your project, or select files/folders in the IDEA project panel
  2. Right-click on the file content or folder
  3. Select ExportYapi / ExportPostman / ExportMarkdown to export all APIs in the file or folder

Method 3: Call API

  1. Open a file containing APIs in your project
  2. Click the gutter icon next to the API method
  3. Send API requests directly from the IDE

See Call API for more details.

Export Only Selected Methods

Since v3.2.0, EasyYapi 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 (YApi, Postman, Markdown, cURL, HttpClient). If no methods are selected, the whole containing class is exported as before.

Released under the Apache-2.0 License.