支持以下使用方法
打开项目中的包含rpc的文件或者在IDEA的左边项目文件区域选择文件或者文件夹
使用快捷键alt shift E(windows)/ctrl E(mac)
然后选择要导出的API,选择导出渠道Yapi/Markdown
点击[✔]按钮或者按回车键完成导出
打开项目中的包含rpc的文件
右键文件内容选择Generate...或者用[Alt + Insert]/[Ctrl+Enter](快捷键可能不一样)"
然后选择ExportYapi/ExportMarkdown
在IDEA的左边项目文件区域选择文件或者文件夹 鼠标点击最上方Code > ExportYapi/ExportMarkdown
rpc相关规则
| 规则的key | 规则目标(上下文) | 版本 | 规则描述 |
|---|---|---|---|
| ☆mdoc.class.filter | class | v0.9.5+ | 选择哪些类可以导出方法文档(rpc) |
| mdoc.method.filter | method | v0.9.5+ | 选择哪些方法可以导出方法文档(rpc) |
| ☆mdoc.method.path | method | v0.9.5+ | 设置方法文档(rpc)的路径 |
| mdoc.method.http.method | method | v0.9.5+ | 设置方法文档(rpc)HTTP请求方式 |
点击规则配置查看更多.
导出rpc方法的功能默认是关闭的 , 开启需要勾选:Preferences(Settings) > Other Settings > EasyApi > Support > methodDoc , 参见:IDEA配置
rpc文档支持导出到yapi/markdown