YApi 二次开发踩坑分享

前端

2023-12-01 18:37:21

二次开发前的准备

在对 YApi 进行二次开发前，我们需要做一些准备工作。

安装 Node.js 和 npm

YApi 是基于 Node.js 开发的，因此我们需要先安装 Node.js 和 npm。
克隆 YApi 源码

使用 git 命令克隆 YApi 源码到本地。
安装 YApi 依赖库

在 YApi 源码目录下，运行以下命令安装依赖库：
```
npm install
```
启动 YApi 服务

在 YApi 源码目录下，运行以下命令启动 YApi 服务：
```
npm start
```
访问 YApi 后台

在浏览器中访问 http://localhost:3000，即可访问 YApi 后台。

二次开发步骤

完成准备工作后，就可以开始对 YApi 进行二次开发了。

修改源码

在 YApi 源码中找到要修改的文件，然后进行修改。例如，要在 YApi 中添加一个新的 API 接口，可以在 app/routes/api.js 文件中添加以下代码：

router.post('/api/create', async (ctx) => {
  const body = ctx.request.body;
  const api = new Api(body);
  await api.save();
  ctx.body = {
    code: 0,
    msg: 'success',
    data: api
  };
});

重新打包 YApi

修改源码后，需要重新打包 YApi。在 YApi 源码目录下，运行以下命令重新打包：
```
npm run build
```
重新发布 YApi

重新打包后，就可以重新发布 YApi 了。在 YApi 源码目录下，运行以下命令重新发布：
```
npm run deploy
```

常见问题

在对 YApi 进行二次开发时，可能会遇到一些常见问题。

找不到 YApi 源码中的某个文件

YApi 源码中的文件比较多，可能会找不到某个文件。这时可以尝试使用搜索工具在 YApi 源码中搜索该文件。
修改源码后，重新打包失败

修改源码后，重新打包可能会失败。这时可以尝试检查一下修改的代码是否正确，或者查看一下重新打包命令是否正确。
重新发布 YApi 后，无法访问 YApi 后台

重新发布 YApi 后，可能会无法访问 YApi 后台。这时可以尝试检查一下 YApi 服务是否启动，或者查看一下 YApi 服务的端口号是否正确。