The following usage are supported
Open the file containing the RPCs in the project or select the file or folder in the project file area on the left of IDEA
Use shortcut alt shift E(windows)/ctrl E(mac)
Then select the RPCs, and select the export channel Markdown
Click [✔] button or press enter to confirm the export.
Open the file containing the RPCs in the project
Right-click file editor then select Generate... or use shortcut[Alt + Insert]/[Ctrl+Enter]
Next,select ExportMarkdown
Select the file or folder in the project file area on the left of IDEA Click Code > ExportMarkdown on the top of IDEA.
rpc rules
| key | target(context) | version | desc |
|---|---|---|---|
| ☆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.
The feature to export RPC methods is disabled by default. To enable it, you need to check the following path: 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.