# gohub

**Repository Path**: accumulate-steadily/gohub

## Basic Information

- **Project Name**: gohub
- **Description**: go1.9版本，主要是 gin + gorm 开发的api接口
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-03-08
- **Last Updated**: 2023-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: Go语言

## README

# Go-API

go1.9版本，主要是 gin + gorm 开发的api接口 

## 使用
```.env
git clone 本仓库地址
go mod tidy # 下载依赖
# 创建数据库，sql文件在 sql_histroy
# copy .env.example .env 创建配置文件
go run main.go # 启动
```
- docs目录下是postman接口的json文件，可直接导入
- `go run mian.go -h` 查看可用的命令


## 所有路由

|请求方法|	API 地址|	说明|
| -------- | -------- | -------- |
|POST|	/api/v1/auth/login/using-phone	|短信 + 手机号登录|
|POST|	/api/v1/auth/login/using-password|	手机号、用户名、邮箱 + 密码|
|POST	/api/v1/auth/login/refresh-token|	刷下 Token|
|POST|	/api/v1/auth/password-reset/using-email|	邮件密码重置|
|POST	|/api/v1/auth/password-reset/using-phone|	短信验证码密码重置|
|POST	|/api/v1/auth/signup/using-phone	|使用手机号注册|
|POST	|/api/v1/auth/signup/using-email	|使用邮箱注册|
|POST	|/api/v1/auth/signup/phone/exist	|手机号是否已注册|
|POST	|/api/v1/auth/signup/email/exist	|email 是否已支持|
|POST	|/api/v1/auth/verify-codes/phone	|发送短信验证码|
|POST	|/api/v1/auth/verify-codes/email	|发送邮件验证码|
|POST	|/api/v1/auth/verify-codes/captcha	|获取图片验证码|
|GET	|/api/v1/user	|获取当前用户|
|GET	|/api/v1/users	|用户列表|
|PUT	|/api/v1/users	|修改个人资料|
|PUT	|/api/v1/users/email	|修改邮箱|
|PUT	|/api/v1/users/phone	|修改手机号|
|PUT	|/api/v1/users/password	|修改密码|
|PUT	|/api/v1/users/avatar	|上传头像|
|GET	|/api/v1/categories	|分类列表|
|POST	|/api/v1/categories	|创建分类|
|PUT	|/api/v1/categories/:id	|更新分类|
|DELETE	|/api/v1/categories/:id	|删除分类|
|GET	|/api/v1/topics	|话题列表|
|POST	|/api/v1/topics	|创建话题|
|PUT	|/api/v1/topics/:id	|更新话题|
|DELETE	|/api/v1/topics/:id	|删除话题|
|GET	|/api/v1/topics/:id	|获取话题|
|GET	|/api/v1/links	|友情链接列表|

## 第三方依赖
使用到的开源库：

- gin —— 路由、路由组、中间件
- zap —— 高性能日志方案
- gorm —— ORM 数据操作
- cobra —— 命令行结构
- viper —— 配置信息
- cast —— 类型转换
- redis —— Redis 操作
- jwt —— JWT 操作
- base64Captcha —— 图片验证码
- govalidator —— 请求验证器
- limiter —— 限流器
- email —— SMTP 邮件发送
- aliyun-communicate —— 发送阿里云短信
- ansi —— 终端高亮输出
- strcase —— 字符串大小写操作
- pluralize —— 英文字符单数复数处理
- faker —— 假数据填充
- imaging —— 图片裁切