Export RPC

You can export your RPCs to Markdown using any of these methods:

Keyboard Shortcut

  • Open the file containing the RPCs in the project, or select file/folder in the project explorer
  • Press Alt + Shift + E (Windows) or Ctrl + E (Mac)
  • In the export dialog:
    • Select the RPCs you want to export
    • Choose Markdown as the export channel
    • Click [✔] or press Enter to confirm

Context Menu

  • Open the file containing the RPCs in the project
  • Right-click on the file editor
  • Navigate to Generate... or use shortcut Alt + Insert (Windows) / Ctrl + Enter (Mac)
  • Select Export Markdown
  • Select the file or folder in the project explorer
  • Click Code > Export Markdown in the main menu at the top of the IDE

RPC Rules

Key Target(context) Version Description
☆mdoc.class.filter class v0.9.5+ Filter classes which can export method documents(rpc)
mdoc.method.filter method v0.9.5+ Filter methods which can export method documents(rpc)

Click config rule to view more.

Important Notes

  • The feature to export RPC methods is disabled by default. To enable it, check: Preferences(Settings) > Other Settings > EasyApi > Support > methodDoc. For more information, please refer to the IDEA config

  • The exported RPC document supports only the Markdown format.

Export to Markdown
Advanced