Ada0317 / TodoList

Gin 使用 RESTful API 规范搭建备忘录

Todo List 备忘录

此项目使用Gin+Gorm ，基于RESTful API实现的一个备忘录。

此项目比较适合小白入门web开发这一方面

接口文档

Todo List 接口文档

密码：0000

项目主要功能介绍

• 用户注册登录 ( jwt-go鉴权 )
• 新增/删除/修改/查询 备忘录
• 存储每条备忘录的浏览次数
• 分页功能

项目主要依赖：

Golang V1.15

• Gin
• Gorm
• mysql
• redis
• ini
• jwt-go

项目结构

TodoList/
├── api
├── cache
├── conf
├── middleware
├── model
├── pkg
│  ├── e
│  ├── logging
│  ├── util
├── routes
├── serializer
└── service

• api : 用于定义接口函数
• cache : 放置redis缓存
• conf : 用于存储配置文件
• middleware : 应用中间件
• model : 应用数据库模型
• pkg/e : 封装错误码
• pkg/logging : 日志打印
• pkg/util : 工具函数
• routes : 路由逻辑处理
• serializer : 将数据序列化为 json 的函数
• service : 接口函数的实现

配置文件

conf/config.ini

# debug开发模式,release生产模式
[service]
AppMode = debug
HttpPort = :3000
# 运行端口号 3000端口

[redis]
RedisDb = redis
RedisAddr = 
# redis ip地址和端口号
RedisPw = 
# redis 密码
RedisDbName = 2
# redis 名字

[mysql]
Db = mysql
DbHost =
# mysql ip地址
DbPort = 
# mysql 端口号
DbUser = 
# mysql 用户名
DbPassWord = 
# mysql 密码
DbName = 
# mysql 名字

简要说明

1. mysql是存储主要数据
2. redis用来存储备忘录的浏览次数

项目运行

本项目使用Go Mod管理依赖。

下载依赖

go mod tidy

运行

go run main.go