1、需要在项目 package.json 文件中添加openapi引用
scripts 属性中添加脚本
"openapi": "max openapi"
devDependencies 属性中添加引用
@umijs/max-plugin-openapi
2、在项目 umirc.ts 文件中配置openapi
plugins: ['@umijs/max-plugin-openapi'],
openAPI: [
{
requestLibPath: "import { request } from '@umijs/max'",
schemaPath: 'API地址',
projectName: 'api'
}
]
3、运行命令 npm run openapi 即可生成接口
遇到的问题及解决方案:
- 提示错误 Error: Invalid command openapi, it’s not registered.是由于没有安装插件,配置好引用后执行命令 npm install 即可
- 提示错误 TypeError: Cannot read properties of undefined (reading ‘split’) 是由于项目中 package.json 文件不包含name这个属性,添加该属性即可