使用
EasyYapi 支持以下使用方法:
方式一:快捷键导出
- 打开项目中包含 API 的文件,或者在 IDEA 左边项目文件区域选择文件或文件夹
- 使用快捷键
Alt + Shift + E(Windows/Linux) 或Ctrl + E(macOS) - 选择要导出的 API
- 选择导出渠道:
YApi/Markdown/Postman - 点击 ✔ 按钮或按回车键完成导出
方式二:右键导出
- 打开项目中包含 API 的文件,或者在 IDEA 左边项目文件区域选择文件或文件夹
- 鼠标右键点击文件内容或文件夹
- 选择
ExportYapi/ExportPostman/ExportMarkdown导出该文件或文件夹中所有的 API
方式三:调用 API
- 打开项目中包含 API 的文件
- 右键文件内容选择
Call - 在 IDE 中直接发起 API 请求
详见 Call API。
仅导出选中的方法
自 v3.2.0 起,EasyYapi 在导出时会尊重方法级选择。在触发导出之前,在编辑器中选中一个或多个方法(通过光标定位或拖选覆盖方法的文本范围)——只会导出源方法匹配(或覆盖)所选方法的端点,而不是包含类中的所有端点。
这对所有导出渠道均生效(YApi、Postman、Markdown、cURL、HttpClient、Hoppscotch、OpenAPI、ApiPost)。若未选中任何方法,则仍按以往行为导出整个包含类。
复制 API 地址
- 在编辑器或 Project 视图中选中一个或多个方法、一个类,或若干文件/文件夹
- 右键选择 EasyYapi > Copy API URL
- 所选范围内每个端点的地址会逐条复制到剪贴板,每行一条,格式为
METHOD /path
与 API Explorer 中只复制路径的 Copy Path 不同,Copy API URL 会带上 HTTP 方法——这样 GET /user/{id} 与 PUT /user/{id} 才能区分开。可以在 Features 中关闭(Copy API URL)。