Easy Yapi
在项目根目录配置yapi.json
{
"list": [
{
"project_id": "you yapi project id",
"token": "you yapi project token"
}
]
}
请求语句同样可以在 yapi.json
配置,例如:
{
// ....
"import": import request from '@common/utils/request'
// or
// "import": import { request } from '@common/utils/request'
}
当配置了 import
之后,Add Api
命令从使用该 import 语句中的名称 request
对于,服务经过变更后yapi
上定义的接口地址和实际接口不一致的情况,可以在yapi.json
增加replacePath
配置:
{
//...
"replacePaths": [["api/admin", "api/admin/ss"]]
}
上面的配置,会在第一轮搜索不到后,替换后进行第二轮搜索,支持多个.
注意:replacePaths不要添加前置/
和后置/
举个例子:
- 原有接口
api/admin/a/list/
会被替换为 api/admin/ss/a/list/
- 原有接口
/api/admin/a/list/
会被替换为 /api/admin/ss/a/list/
- 原有接口
pre/api/admin/a/list/
会被替换为 pre/api/admin/ss/a/list/
- 原有接口
pre/api/admin/ss/list/
因为包含了api/admin/ss/ss/list/
所以不做替换
Kill Any
在需要替换的ts文件内,右键选择 Kill Any
命令
Add Api
在ts文件内,右键选择 Add Api
命令,在输入框中输入yapi地址,会自动在当前文件生成接口代码