/gin-admin

RBAC scaffolding based on Gin + GROM + Casbin + Ant Design React

Primary LanguageGoMIT LicenseMIT

Gin Admin

基于 Gin + GORM + Casbin 实现的RBAC权限管理脚手架，目的是提供一套轻量的中后台开发框架，方便、快速的完成业务需求的开发。

ReportCard GoDoc License

  • 在线演示地址 (用户名：root，密码：abc-123)（温馨提醒：为了达到更好的演示效果，这里给出了拥有最高权限的用户，请手下留情，只操作自己新增的数据，不要动平台本身的数据！谢谢！）
  • Swagger 文档地址

特性

  • 遵循 RESTful API 设计规范
  • 基于 Casbin 的 RBAC 访问控制模型
  • 存储分离(存储层对外采用接口的方式供业务层调用，实现了存储层的完全隔离，可以非常方便的更换存储方式)
  • 日志追踪(基于logrus，日志钩子支持 gorm)
  • JWT 认证(基于黑名单的认证模式，存储支持：file/redis)
  • 支持 Swagger 文档
  • 单元测试

下载并运行

获取代码

go get -v github.com/LyricTian/gin-admin/cmd/ginadmin

运行

root 用户的用户名及密码在配置文件(configs/ginadmin/config.toml)中，默认为：root/abc-123

运行服务

也可以使用脚本运行(详情可查看Makefile)：make start

ginadmin -c ./configs/ginadmin/config.toml -m ./configs/ginadmin/model.conf -swagger ./internal/app/ginadmin/swagger

温馨提醒

  1. 默认配置采用的是 sqlite 数据库，数据库文件(自动生成)在data/gadmin.db。如果想切换为mysql或postgres，请更改配置文件，并创建数据库（数据库创建脚本在script目录下）。
  2. 日志的默认配置为标准输出，如果想切换到写入文件或写入到 gorm 存储，可以自行切换配置。

前端实现

Swagger 文档的使用

文档规则请参考：https://github.com/teambition/swaggo/wiki/Declarative-Comments-Format

安装工具并生成文档

go get -u -v github.com/teambition/swaggo
swaggo -s ./internal/app/ginadmin/swagger.go -p . -o ./internal/app/ginadmin/swagger

生成文档之后，可在浏览器中输入地址访问：http://127.0.0.1:10088/swagger/

项目结构概览

├── cmd
│   └── ginadmin：主服务
├── configs
│   └── ginadmin：配置文件目录
├── docs：文档
├── internal：内部应用
│   └── app
│       └── ginadmin：主应用目录
│           ├── bll：业务逻辑层
│           ├── config：配置参数（与配置文件一一映射）
│           ├── context：统一上下文管理
│           ├── ginplus：gin的扩展函数库
│           ├── middleware：gin中间件
│           ├── model：存储层
│           │   └── gorm
│           │       ├── entity：与数据库映射的实体层
│           │       └── model：gorm实现的存储层
│           ├── routers：路由层
│           │   └── api：/api路由模块
│           │       └── ctl：/api路由模块对应的控制器层
│           ├── schema：对象模型
│           ├── swagger：swagger静态目录
│           └── test：单元测试
├── pkg：公共模块
│   ├── auth：认证模块
│   │   └── jwtauth
│   │       └── store
│   │           ├── buntdb
│   │           └── redis
│   ├── errors：错误处理模块
│   ├── gormplus：gorm扩展实现
│   ├── logger：日志模块
│   │   └── hook
│   │       └── gorm
│   └── util：工具类
├── scripts：执行脚本
└── vendor：依赖包

感谢以下框架的开源支持

MIT License

Copyright (c) 2019 Lyric

与作者对话

该项目是利用业余时间进行开发的，开发思路主要是来源于自己的项目积累及个人思考，如果您有更好的想法和建议请与我进行沟通，我非常期待！下面是我的微信二维码：