README_CN.md

简体中文 | English

简介

apioak-admin 是apioak网关的控制面后端项目，基于 Go 1.16 和 Gin 1.7.2 开发，项目配合数据面的项目 apioak 一起使用。 该项目旨在简化apioak的上手使用，优化用户的操作，已达到极简的操作即可完成一个完整服务配置的上线与发布。

快速开始

为方便使用，这里将前后端项目合并打包了开箱即用的可执行文件，只需要在 发行列表（gitee） 中下载压缩包并解压，然后配置对应目录下的 config/app.yaml 配置文件并执行可执行文件即可完成项目的部署。访问 config/app.yaml 配置文件中的 server 配置项的内容即可。

自主编译

go build -o apioak-admin main.go

依赖安装

在不同的操作系统上安装 apioak-admin 所必需的系统依赖（MySQL >= 5.7 或 MariaDB >= 10.2等），请参见：依赖安装文档。

配置

• 导入数据库配置文件到 MySQL 或 MariaDB 中，数据表文件路径 /{path}/config/apioak.sql。

• 在编译命令后生成的 apioak-admin 可执行文件的所在目录创建 config 目录，同时将 apioak-admin 项目下的配置文件 app_example.yaml 复制到该目录下，并更改名称为 app.yaml ，然后在该配置文件中配置。

  • database: 数据库连接信息。
  • token：用户登录签发token配置信息。
  • server: 启动服务后访问服务的信息。
  • apioak： 数据面配置同步连接信息。
  • logger：记录日志配置信息。
  • validator：参数验证信息的语言。 zh:中文（默认）、 en:英文

运行

直接执行可执行文件即可完成项目启动。

./apioak-admin