Skip to content

Dot-Liu/apinto-dashboard

 
 

Repository files navigation

Apinto Dashboard

Go Report Card Releases LICENSE

  • Apinto Dashboard项目main分支与Apinto项目main分支同步更新

  • 当前Apinto Dashboard最新版本为v1.0.4-betaApinto要求版本不低于v0.6.4

注意:main分支为开发主要分支,频繁更新可能导致使用不稳定,若需要使用稳定版本,请查看release

什么是Apinto Dashboard

Apinto Dashboard是开源网关Apinto的可视化UI项目。

此后,大家将告别繁琐复杂的命令行Curl命令,只需在Dashboard上轻轻一点,便可实现与开源网关Apinto的交互,极大地简化了Apinto的配置流程,降低了学习及使用成本。

Apinto DashboardApinto交互流程如下图所示

Apinto Dashboard与Apinto交互流程图

编译

  1. 进入build/cmd文件夹,执行编译脚本
cd builds/cmd && ./build.sh {版本号}
  1. 编译后的文件存放在 out/apinto-dashboard-{版本号} 文件夹中

部署

  1. 启动Apinto开源网关,Apinto启动教程请点击

  2. 下载并解压安装包

wget https://github.com/eolinker/apinto-dashboard/releases/download/${version}/apinto-dashboard-${version}.linux.x64.tar.gz && tar -zxvf apinto-dashboard-${version}.linux.x64.tar.gz && cd apinto-dashboard

上述命令中的 ${version}Apinto dashboard的版本号,需要根据 Apinto 版本部署对应的 Apinto Dashboard 版本

下表为Apinto和Apinto Dashboard的版本联系

Apinto版本 Apinto Dashboard版本
0.8.x v1.1.0-beta
v0.6.x-0.7.x v1.0.4-beta

下列示例命令以Apinto Dashboard v1.1.0-beta版本为例

wget https://github.com/eolinker/apinto-dashboard/releases/download/v1.1.0-beta/apinto-dashboard-v1.1.0-beta.linux.x64.tar.gz && tar -zxvf apinto-dashboard-v1.1.0-beta.linux.x64.tar.gz && cd apinto-dashboard
  1. 编辑配置文件config.yml
zone: zh_cn # 时区,根据时区获取当地语言的前端渲染页面,可选项:zh_cn|ja_jp| en_us,当前版本仅支持zh_cn
default: monitor
apinto:		# Apinto openAPI地址列表,若有多个节点,可填写多个节点的openAPI地址
  - "http://127.0.0.1:9400"   
port: 8081    # dashboard监听端口
user_details:	# 用户账号获取渠道
  type: file	# 文件,当前版本只支持读取文件
  file: ./account.yml	# 文件名称
professions:    # 流程阶段,下面配置中的name和profession为dashboard在apinto的映射名称,下述配置内容将会在dashboard导航栏中展现
  - name: services    # dashboard模块:服务
    profession: service # apinto模块:服务
    i18n_name:    # 国际化语言名称
      zh_cn: 上游服务   # 中文描述
      en_us: upstream services  # 英文描述
  - name: templates  # dashboard模块:插件模版
    profession: template # apinto模块:插件模版
    i18n_name:
      zh_cn: 模版
      en_us: template
  - name: discoveries    # dashboard模块:服务发现
    profession: discovery    # apinto模块:服务发现
    i18n_name:
      zh_cn: 服务发现
      en_us: discoveries
  - name: outputs        # dashboard模块:输出器
    profession: output    # apinto模块:输出器
    i18n_name:
      zh_cn: 输出
      en_us: outputs

用户账号、密码默认均为admin。如若需要修改账号密码信息,可编辑account.yml文件,语法遵从yaml语法,配置详细说明如下:

account_list: # 账号列表
- user_name: admin	# 账号
  password: admin		# 密码
  info:							# 基本信息
    desc: admin用户		# 描述
  1. 启动程序

(1) 在当前窗口运行,该方式启动的程序,当窗口关闭,进程也会关闭

./apinto-dashboard

(2)在后台运行

nohup ./apinto-dashboard > logs/stdout_apinto-dashboard_"$(date ‘+%Y%m%d-%H%M%S‘)".log 2>&1 &
  1. 浏览器打开Apinto Dashboard地址,本示例在本地部署,因此ip为127.0.0.1,端口为8081

image-20220616181447371

  1. 在浏览器中输入账号密码登录即可

至此,部署启用教程已结束,如需了解更多使用教程,请点击更多(教程文档正在赶工中)

联系我们

关于我们

EOLINK 是领先的 API 管理服务供应商,为全球超过3000家企业提供专业的 API 研发管理、API自动化测试、API监控、API网关等服务。是首家为ITSS(中国电子工业标准化技术协会)制定API研发管理行业规范的企业。

官方网站:https://www.eolink.com

免费下载PC桌面端:https://www.eolink.com/pc/

Packages

No packages published

Languages

  • JavaScript 44.5%
  • HTML 37.0%
  • Go 14.3%
  • CSS 3.6%
  • Other 0.6%