Skip to content

YApi 配置 ​

IDE 设置 ​

在 IDE 中配置 YApi 设置:

Settings > Other Settings > EasyApi > YApi

设置项说明
Yapi ServerYApi 服务器地址
Tokens项目 Token,格式为 module=token(每行一个)
Export Mode导出时如何处理已有 API(见下方)
Request body JSON5请求体使用 JSON5 格式(默认:关闭)
Response body JSON5响应体使用 JSON5 格式(默认:关闭)

General 标签页中的附加选项:

设置项默认值说明
Enable URL Templatingtrue启用路径参数的 URL 模板化
Switch Noticetrue切换 YApi 项目时显示通知

获取 YApi Token ​

  1. 登录 YApi
  2. 进入项目设置
  3. 复制项目 Token

无需手动填写 Token

导出 API 时不需要事先在设置中填入 Token(或服务器地址)。当插件向 YApi 导出时,会自动弹出对话框,要求输入 YApi 服务器地址以及目标模块对应的项目 Token。在其中输入后,插件会自动保存,下次导出时直接复用。

上方的 Tokens 输入框只是为了方便一次性预填多个模块的 Token,可选项。

Token 格式 ​

Token 以 module=token 的格式指定,在 IDE 的 Tokens 字段中每行输入一个。模块名用于将 API 匹配到正确的 YApi 项目。

导出模式 ​

模式说明
ALWAYS_UPDATE始终更新已有 API(默认)
NEVER_UPDATE从不更新已有 API
ALWAYS_ASK弹窗询问是否覆盖每个 API
UPDATE_IF_CHANGED仅当 API 内容发生变化时更新

配置文件规则 ​

以下规则可以在配置文件(.easy.api.config)中设置:

规则说明
yapi.project设置 API 分组所属的 YApi 项目
yapi.export.beforeYApi 导出前事件
yapi.save.before保存到 YApi 前事件
yapi.save.after保存到 YApi 后事件

YApi Mock ​

EasyYapi 支持将字段 Mock 规则同步到 YApi Mock 服务。

详见 YApi Mock。

基于 Apache-2.0 许可发布