开发指南

Dashboard 包含了 manager-api 与 web 两部分，因此需要分别启动开发环境。

环境准备

在开发前，请参考该指南以安装依赖。

克隆项目

$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git

开始开发

$ cd apisix-dashboard

manager-api

  1. 请在 api/conf/conf.yaml 中修改配置信息。

  2. 在根目录下，启动开发模式

$ make api-run
  1. 在根目录下，关闭开发模式
$ make api-stop
  1. 关于增加自定义插件或修改插件 schema 后在控制台显示异常的问题，请查阅 FAQ 汇总关于该问题的描述。

web

  1. 进入 web 目录。
$ cd ./web

  1. 请在 config/proxy.ts 文件中修改 manager-api 地址。

  2. 启动开发模式

$ yarn install

$ yarn start
  1. 如编写 E2E 测试，请参考 E2E 编写指南