Skip to content

使用 ​

EasyYapi 支持以下使用方法:

方式一:快捷键导出 ​

  1. 打开项目中包含 API 的文件,或者在 IDEA 左边项目文件区域选择文件或文件夹
  2. 使用快捷键 Alt + Shift + E (Windows/Linux) 或 Ctrl + E (macOS)
  3. 选择要导出的 API
  4. 选择导出渠道:YApi / Markdown / Postman
  5. 点击 ✔ 按钮或按回车键完成导出

方式二:右键导出 ​

  1. 打开项目中包含 API 的文件,或者在 IDEA 左边项目文件区域选择文件或文件夹
  2. 鼠标右键点击文件内容或文件夹
  3. 选择 ExportYapi / ExportPostman / ExportMarkdown 导出该文件或文件夹中所有的 API

方式三:调用 API ​

  1. 打开项目中包含 API 的文件
  2. 右键文件内容选择 Call
  3. 在 IDE 中直接发起 API 请求

详见 Call API。

仅导出选中的方法 ​

自 v3.2.0 起,EasyYapi 在导出时会尊重方法级选择。在触发导出之前,在编辑器中选中一个或多个方法(通过光标定位或拖选覆盖方法的文本范围)——只会导出源方法匹配(或覆盖)所选方法的端点,而不是包含类中的所有端点。

这对所有导出渠道均生效(YApi、Postman、Markdown、cURL、HttpClient、Hoppscotch、OpenAPI、ApiPost)。若未选中任何方法,则仍按以往行为导出整个包含类。

导出契约接口 ​

当映射注解(@RequestMapping 等)位于接口上、框架注解(@RestController)位于其实现类上时——这是常见的服务端分层方式——可以直接对接口(或接口上的方法)触发导出。自 v3.2.6 起,导出会将契约展开到其实现类并导出这些端点,而不是报 "No API endpoints found" 错误。

同时选中分层两边的选择(契约接口与实现它的 API 类)时,每个端点只会导出一次。Project 视图中的选择行为不变:选择目录时只导出该目录自身的类,不会导出目录枚举到的接口的实现类。

这对所有导出渠道均生效。

复制 API 地址 ​

  1. 在编辑器或 Project 视图中选中一个或多个方法、一个类,或若干文件/文件夹
  2. 右键选择 EasyYapi > Copy API URL
  3. 所选范围内每个端点的地址会逐条复制到剪贴板,每行一条,格式为 METHOD /path

与 API Explorer 中只复制路径的 Copy Path 不同,Copy API URL 会带上 HTTP 方法——这样 GET /user/{id} 与 PUT /user/{id} 才能区分开。可以在 Features 中关闭(Copy API URL)。

基于 Apache-2.0 许可发布