Skip to content

airlovelq/gin-frame

Repository files navigation

gin-frame

介绍

基于golang的gin框架,搭建的基础后端服务开发项目,可根据需要扩展,并快速开发直接编写业务

软件架构

  1. docs: swagger文档,通过gin-swagger生成
  2. controller:controller层文件,开发业务
  3. database: 数据库操作
  4. middleware: 中间件操作,目前只做了缓存redis的操作,可根据需要添加消息中间件等操作
  5. response: 设计的返回参数,code, data, msg三个字段
  6. errorcode: 错误码定义,可根据需要添加错误码
  7. utils: 一些公共函数,email发送,参数校验等,可根据需要添加和扩展
  8. secret: 加密解密相关操作,目前有jwt token解析和生成,rsa加密解密,base64等操作,可根据需要继续添加和扩展

安装教程

  1. 安装gin-swagger,如果需要自动生成文档,可执行swag init生成文档
  2. 编译,运行

使用说明

  1. 因为目前一般针对的项目都是用kubernetes部署的,所以很多配置都是用的环境变量来设置的

参与贡献

  1. Fork 本仓库
  2. 新建 Feat_xxx 分支
  3. 提交代码
  4. 新建 Pull Request

码云特技

  1. 使用 Readme_XXX.md 来支持不同的语言,例如 Readme_en.md, Readme_zh.md
  2. 码云官方博客 blog.gitee.com
  3. 你可以 https://gitee.com/explore 这个地址来了解码云上的优秀开源项目
  4. GVP 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目
  5. 码云官方提供的使用手册 https://gitee.com/help
  6. 码云封面人物是一档用来展示码云会员风采的栏目 https://gitee.com/gitee-stars/

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages