Gohub 以论坛 API 为主题,其设计初衷是将其打造为高性能、功能齐全的 API 框架。基于 gin, cobra, viper, zap, gorm, Redis, MySQL, sqlite, email, jwt
Gohub 以论坛 API 为主题,其设计初衷是将其打造为高性能、功能齐全的 API 框架。基于 gin, cobra, viper, zap, gorm, Redis, MySQL, sqlite, email, jwt
本项目是 《G02 Go API 实战》 实战课程的源码,基于 MIT 协议开源。
项目名称 Gohub,以论坛 API 为主题,设计的初衷是将其打造为高性能、功能齐全的 API 框架。基于 gin, cobra, viper, zap, gorm, redis, mysql, sqlite, email, jwt.
程序结构说明,请见 程序结构。
一套优秀的 API 设计,需要具备如下特性:
详细讲解请见 RESTful API 最佳实践 。
| 请求方法 | 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 | 友情链接列表 |
使用到的开源库:
现在来看下我们自建的库:
Gohub 项目总共有 4600 行代码(工具 gocloc):
……make 命令:
…migrate 命令:
$ go run main.go migrate -h
Run database migration
Usage:
migrate [command]
Available Commands:
down Reverse the up command
fresh Drop all tables and re-run all migrations
refresh Reset and re-run all migrations
reset Rollback all database migrations
up Run unmigrated migrations
Flags:
-h, --help help for migrate
Global Flags:
-e, --env string load .env file, example: --env=testing will use .env.testing file
Use " migrate [command] --help" for more information about a command.暂无开放 Issues,或尚未同步最近议题。