go-nunu/nunu-layout-admin 项目API接口详解

项目概述

go-nunu/nunu-layout-admin 是一个基于Go语言开发的后台管理系统框架，提供了完整的权限管理、用户管理、菜单管理等后台系统常见功能。本文将从技术角度详细解析该项目的API接口设计，帮助开发者更好地理解和使用该系统。

核心模块分析

1. 用户管理模块

用户管理模块提供了管理员用户的增删改查功能，是系统的基础模块之一。

用户数据结构

AdminUserDataItem:
  properties:
    id: integer
    username: string  # 用户名，必填
    password: string  # 密码，必填
    nickname: string  # 昵称
    email: string     # 邮箱
    phone: string     # 手机号
    roles: array      # 角色列表
    createdAt: string # 创建时间
    updatedAt: string # 更新时间

关键接口

• 创建用户 (POST /v1/admin/user)

  • 必填字段：username, password
  • 可选字段：nickname, email, phone, roles
  • 密码建议在前端进行加密处理

• 获取用户列表 (GET /v1/admin/users)

  • 支持分页参数：page, pageSize
  • 返回数据结构包含列表和总数

• 更新用户信息 (PUT /v1/admin/user)

  • 必须包含用户ID
  • 可以更新除密码外的所有信息

2. 权限管理模块

权限管理模块定义了系统的API访问权限，是RBAC权限模型的核心部分。

API数据结构

ApiDataItem:
  properties:
    id: integer
    group: string   # API分组(如"权限管理")
    name: string    # API名称(如"菜单列表")
    method: string  # 请求方法(GET/POST等)
    path: string    # API路径(如"/v1/test")
    createdAt: string
    updatedAt: string

关键接口

• 创建API (POST /v1/admin/api)

  • 需要指定分组、名称、方法和路径
  • 路径应遵循RESTful规范

• 获取API列表 (GET /v1/admin/apis)

  • 支持按分组、名称、路径和方法过滤
  • 返回结果包含分组信息和API列表

3. 菜单管理模块

菜单管理模块定义了后台管理系统的导航结构，支持多级菜单配置。

菜单数据结构

MenuDataItem:
  properties:
    id: integer       # 菜单ID
    parentId: integer # 父菜单ID
    title: string     # 显示名称
    name: string      # 路由名称(唯一标识)
    path: string      # 路由路径
    component: string # 前端组件
    icon: string      # 图标
    weight: integer   # 排序权重
    keepAlive: boolean # 是否保活
    hideInMenu: boolean # 是否隐藏
    locale: string    # 本地化标识
    url: string       # iframe模式URL
    redirect: string  # 重定向地址

关键接口

• 创建菜单 (POST /v1/admin/menu)

  • 支持多级菜单配置(parentId)
  • 可以设置图标、权重等显示属性
  • 支持iframe模式和普通路由模式

• 获取菜单树 (GET /v1/admin/menus)

  • 返回完整的菜单树结构
  • 前端可根据此数据渲染导航菜单

4. 角色管理模块

角色管理模块实现了RBAC权限模型中的角色概念，是权限分配的基础单元。

角色数据结构

RoleDataItem:
  properties:
    id: integer
    name: string   # 角色名称
    sid: string    # 角色标识符
    createdAt: string
    updatedAt: string

关键接口

• 创建角色 (POST /v1/admin/role)

  • 需要指定角色名称和标识符
  • 标识符应保持唯一

• 分配权限 (PUT /v1/admin/role/permissions)

  • 为指定角色分配API权限
  • 权限列表为API的路径字符串数组

认证与授权

系统采用Bearer Token认证方式：

• 登录接口 (POST /v1/auth/login)

  • 需要用户名和密码
  • 返回accessToken用于后续请求认证

• 所有管理接口都需要在Header中添加：

  Authorization: Bearer <accessToken>
  

最佳实践建议

1. 用户密码安全

   • 前端应对密码进行加密后再传输
   • 后端应使用强哈希算法(如bcrypt)存储密码

2. API设计规范

   • 遵循RESTful设计原则
   • 使用合适的HTTP方法(GET/POST/PUT/DELETE)

3. 权限控制

   • 为每个角色分配最小必要权限
   • 定期审计权限分配情况

4. 菜单配置

   • 合理规划菜单层级，一般不超过三级
   • 使用权重(weight)控制菜单显示顺序

总结

go-nunu/nunu-layout-admin 项目提供了一套完整的后台管理系统解决方案，通过清晰的模块划分和规范的API设计，开发者可以快速构建安全可靠的管理系统。本文详细解析了各模块的数据结构和关键接口，希望能帮助开发者更好地理解和使用该系统。