yapi-plugin-pl-test-dashboard/README.md

YAPI自动化测试结果数据面板插件，支持在YAPI中通过数据可视化的方式查看自动化测试结果。

# yapi-plugin-pl-test-dashboard

在分组的项目导航栏中加入*测试结果数据面板*标签，支持在项目中通过图表的形式查看自动化测试的结果。

建议：搭配 yapi-plugin-pl-auto-test 或者 yapi-plugin-pl-es-storage 一起食用效果更佳。

#### 使用：

###### 第一步：

因为本插件前端可视化依赖@antv/g2plot 插件，所以需要先找到 yapi 的 package.json 文件，并在 dependencies 下增加`"@antv/g2plot": "^1.1.27",` 保存之后执行`npm install` 下载@antv/g2plot 插件。或者使用其他方式安装改插件。

###### 第二步：

在 config.json 这层目录下运行 `yapi plugin --name yapi-plugin-pl-test-dashboard`安装插件

###### 第三步：

修改 config.json 文件：

```json
"plugins": [
    {
      "name": "pl-test-dashboard",
      "options": {
        "esHost": "", // es集群的host地址
        "esUsername": "" ,//es集群访问用户名
        "esPwd": "" ,// es集群用户密码
        "indexName": "" ,//es索引
      }
    }
  ],
```

###### 第四步：

重启服务器

#### 注意：

引入本插件可能会导致首页左侧目录以及接口 tab 栏的菜单样式背景色变为黑色背景，此时需要修改 yapi 源码，找到`class=tree-wrappper`以及`class=m-group`的位置，加入行内样式：`background:#ffffff`。

#### 更新：

##### v1.0.0

- 完成数据的可视化展示

##### v1.1.0

- 增加无数据或者数据获取异常时的异常展示
- 调整样式