Go-Admin 后台管理系统 API 接口详解

Go-Admin 是一个基于 Gin + Vue + Element UI 构建的前后端分离权限管理系统。本文将从技术角度详细解析其 API 接口设计，帮助开发者更好地理解和使用该系统。

系统概述

Go-Admin 提供了完整的后台管理解决方案，包含用户权限管理、部门管理、字典管理等功能模块。其 API 设计遵循 RESTful 规范，采用 JSON 格式进行数据交互。

核心 API 接口解析

1. 系统配置接口

接口路径: /api/v1/app-config

• 功能: 获取系统前台配置信息
• 特点: 此接口不进行权限验证
• 请求方式: GET
• 响应示例:

{
  "code": 200,
  "data": {
    "key1": "value1",
    "key2": "value2"
  }
}

2. 验证码接口

接口路径: /api/v1/captcha

• 功能: 获取登录验证信息
• 请求方式: GET
• 响应示例:

{
  "code": 200,
  "data": "base64编码的验证信息图片",
  "id": "验证信息ID",
  "msg": "提示信息"
}

3. 数据库工具接口

3.1 数据库表分页列表

接口路径: /api/v1/db/tables/page

• 功能: 获取数据库表分页列表
• 请求方式: GET
• 参数:
  • tableName: 数据表名称(可选)
  • pageSize: 每页条数
  • pageIndex: 页码

3.2 表列分页列表

接口路径: /api/v1/db/columns/page

• 功能: 获取指定表的列分页列表
• 请求方式: GET
• 参数:
  • tableName: 数据表名称(必选)
  • pageSize: 每页条数
  • pageIndex: 页码

4. 部门管理接口

4.1 部门分页列表

接口路径: /api/v1/dept

• 功能: 获取部门分页列表
• 请求方式: GET
• 参数:
  • deptName: 部门名称(可选)
  • deptId: 部门ID(可选)
  • position: 职位(可选)

4.2 添加部门

接口路径: /api/v1/dept

• 功能: 添加新部门
• 请求方式: POST
• 请求体:

{
  "deptName": "部门名称",
  "parentId": 父部门ID,
  "sort": 排序值,
  "leader": "负责人",
  "contact": "联系方式",
  "email": "邮箱",
  "status": "状态(0正常 1停用)"
}

4.3 删除部门

接口路径: /api/v1/dept

• 功能: 删除部门
• 请求方式: DELETE
• 请求体:

{
  "id": 部门ID
}

4.4 获取部门详情

接口路径: /api/v1/dept/{deptId}

• 功能: 获取指定部门详情
• 请求方式: GET
• 路径参数:
  • deptId: 部门ID

4.5 修改部门

接口路径: /api/v1/dept/{deptId}

• 功能: 修改部门信息
• 请求方式: PUT
• 路径参数:
  • deptId: 部门ID
• 请求体: 同添加部门接口

5. 字典管理接口

5.1 字典数据列表

接口路径: /api/v1/dict/data

• 功能: 获取字典数据分页列表
• 请求方式: GET
• 参数:
  • status: 状态(可选)
  • dictCode: 字典编码(可选)
  • dictType: 字典类型(可选)
  • pageSize: 每页条数
  • pageIndex: 页码

5.2 添加字典数据

接口路径: /api/v1/dict/data

• 功能: 添加字典数据
• 请求方式: POST
• 请求体:

{
  "dictLabel": "字典标签",
  "dictValue": "字典键值",
  "dictType": "字典类型",
  "cssClass": "样式类",
  "listClass": "表格样式",
  "isDefault": "是否默认",
  "status": "状态(0正常 1停用)",
  "remark": "备注"
}

5.3 删除字典数据

接口路径: /api/v1/dict/data

• 功能: 删除字典数据
• 请求方式: DELETE
• 请求体:

{
  "dictCode": 字典编码
}

5.4 根据key获取字典数据

接口路径: /api/v1/dict-data/option-select

• 功能: 根据字典类型key获取字典数据
• 请求方式: GET
• 参数:
  • dictType: 字典类型(必选)

安全机制

Go-Admin 的 API 采用了以下安全措施:

1. JWT 认证: 大部分接口需要 Bearer Token 认证
2. 权限控制: 基于角色的权限控制
3. 验证信息: 登录接口需要验证信息

最佳实践

1. 接口调用顺序: 先获取验证信息 → 登录获取token → 调用其他接口
2. 错误处理: 检查返回的code字段，非200表示操作失败
3. 分页查询: 合理设置pageSize和pageIndex参数

总结

Go-Admin 的 API 设计规范、功能完善，涵盖了后台管理系统的核心功能。通过本文的详细解析，开发者可以快速掌握各接口的使用方法，为二次开发和系统集成打下坚实基础。