go-nunu/nunu-layout-admin 项目API接口详解
2025-06-19 13:07:54作者:管翌锬
项目概述
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>
最佳实践建议
-
用户密码安全
- 前端应对密码进行加密后再传输
- 后端应使用强哈希算法(如bcrypt)存储密码
-
API设计规范
- 遵循RESTful设计原则
- 使用合适的HTTP方法(GET/POST/PUT/DELETE)
-
权限控制
- 为每个角色分配最小必要权限
- 定期审计权限分配情况
-
菜单配置
- 合理规划菜单层级,一般不超过三级
- 使用权重(weight)控制菜单显示顺序
总结
go-nunu/nunu-layout-admin 项目提供了一套完整的后台管理系统解决方案,通过清晰的模块划分和规范的API设计,开发者可以快速构建安全可靠的管理系统。本文详细解析了各模块的数据结构和关键接口,希望能帮助开发者更好地理解和使用该系统。
登录后查看全文
热门项目推荐
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
- HHunyuan-MT-7B腾讯混元翻译模型主要支持33种语言间的互译,包括中国五种少数民族语言。00
GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0269get_jobs
💼【AI找工作助手】全平台自动投简历脚本:(boss、前程无忧、猎聘、拉勾、智联招聘)Java00AudioFly
AudioFly是一款基于LDM架构的文本转音频生成模型。它能生成采样率为44.1 kHz的高保真音频,且与文本提示高度一致,适用于音效、音乐及多事件音频合成等任务。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile08
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
1 freeCodeCamp课程视频测验中的Tab键导航问题解析2 freeCodeCamp音乐播放器项目中的函数调用问题解析3 freeCodeCamp论坛排行榜项目中的错误日志规范要求4 freeCodeCamp JavaScript高阶函数中的对象引用陷阱解析5 freeCodeCamp全栈开发课程中React组件导出方式的衔接问题分析6 freeCodeCamp英语课程视频测验选项与提示不匹配问题分析7 freeCodeCamp课程页面空白问题的技术分析与解决方案8 freeCodeCamp博客页面工作坊中的断言方法优化建议9 freeCodeCamp 课程中关于角色与职责描述的语法优化建议 10 freeCodeCamp全栈开发课程中测验游戏项目的参数顺序问题解析
最新内容推荐
PCDViewer-4.9.0-Ubuntu20.04:专业点云可视化与编辑工具全面解析 JDK 8u381 Windows x64 安装包:企业级Java开发环境的完美选择 QT连接阿里云MySQL数据库完整指南:从环境配置到问题解决 SAP S4HANA物料管理资源全面解析:从入门到精通的完整指南 VSdebugChkMatch.exe:专业PDB签名匹配工具全面解析与使用指南 OpenSSL 3.3.0资源下载指南:新一代加密库的全面解析与部署教程 基恩士LJ-X8000A开发版SDK样本程序全面指南 - 工业激光轮廓仪开发利器 ZLIB 1.3 静态库 Windows x64 版本:高效数据压缩解决方案完全指南 SteamVR 1.2.3 Unity插件:兼容Unity 2019及更低版本的VR开发终极解决方案 全球36个生物多样性热点地区KML矢量图资源详解与应用指南
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
149
1.95 K

deepin linux kernel
C
22
6

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
980
395

React Native鸿蒙化仓库
C++
192
274

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
931
555

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Jupyter Notebook
75
66

本仓将为广大高校开发者提供开源实践和创新开发平台,收集和展示openHiTLS示例代码及创新应用,欢迎大家投稿,让全世界看到您的精巧密码实现设计,也让更多人通过您的优秀成果,理解、喜爱上密码技术。
C
65
518

为仓颉编程语言开发者打造活跃、开放、高质量的社区环境
Markdown
1.11 K
0