# wall

**Repository Path**: moyantianji/wall

## Basic Information

- **Project Name**: wall
- **Description**: 万能墙项目
- **Primary Language**: Go
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2021-02-04
- **Last Updated**: 2021-02-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Wall万能墙项目
---
## 技术 ✏️
本次项目我们选择Go语言进行后端的开发，选用Ginroute框架、Logrus日志框架、Gorm数据库映射，以后也可以以此为模版进行新项目的开发。
## 目录说明 ☁️
``` 
.
├── README.md
├── app
│   ├── app.go # 后台应用实例返回方法
│   ├── config # 配置文件读取文件
│   │   ├── logger.go
│   │   ├── main.go
│   │   └── redis.go
│   ├── controller # 控制器逻辑
│   │   ├── user.go
│   │   └── warp.go
│   ├── middleware # 中间件验证
│   │   └── auth.go
│   ├── model # 模块实现
│   │   ├── main.go
│   │   ├── type.go
│   │   └── user.go
│   ├── router.go # 路由配置
│   └── utils # 相关工具
│       ├── jwt.go # jwt签发与解析
│       └── randCode.go # 随机6位验证码
├── data
├── dev.yml # 配置文件
├── go.mod # go.mod文件
├── go.sum
├── main.go # 应用程序入口
└── menu # 不同权限用户的菜单

``` 
## 运行方法 配置文件配置项说明 🔧
运行时需要加入命令行参数，读取配置文件相关命令如下：
``` 
./main ./dev.yml
``` 
配置文件说明如下：
``` 
database:
  address: 118.31.171.61  #数据库域名
  port: 3306              #数据库端口
  dbname: wall            #数据库名称
  user: wall              #用户名
  password: wall66        #数据库密码

```
## API文档
### 用户登录
* URL: /login
* Method: POST
#### 前端发送
```
{
    user_name: string
    user_pwd:  string
}
``` 
#### 返回数据
```
{
    data: {
        type:    int,//权限2是普通用户，1是管理员，0是超级管理员。
        user_id: string,
        jwt:     string
    },
    message: null,
    status: "success" || "error"
}
``` 
### 用户注册
* URL: /register
* Method: POST
#### 前端发送
```
{
    user_name:      string,
    user_nick_name: string,
    user_pwd:       string,
    user_tel:       string,
    user_email:     string,
    user_sex:       int,
    user_addr:      string,
    qq:             string,
    wx:             string
}
``` 
#### 返回数据
```
{
    status: "success" || "error"
    message: string
    data: {
        registered: boolean //true表示注册成功
    }
}
``` 
### 验证码发送
* URL: /send_code
* Method: POST
#### 前端发送
```
{
    tel: string
}
```
#### 返回数据
```
{
    status: "success" || "error"
    message: string
    data: {
        sent: boolean //true表示发送成功
    }
}
```
### 验证码验证
* URL: /verify
* Method: POST
#### 前端发送
```
{
    tel: string,
    security_code: string
}
```
#### 返回数据
```
{
    status: "success" || "error"
    message: string
    data: {
        user_id: string,
        identify: boolean
    }
}
```