Community-E-Home

使用后端代码进行调试

(下述Shell指令为 Linux Shell) 0. 配置好 Golang 环境

1. 配置mysql服务器，建议安装mysql的可视化工具(或者使用vscode 并安装本项目推荐拓展)。
2. 建议使用 vscode 作为 IDE 本项目提供数个 拓展建议
3. 在你的某个目录下，通过shell执行： git clone git@github.com:FinleyGe/Community-E-Home.git
4. cd Community-E-Home/server/config
5. 复制config.example.yaml为副本config.yaml cp config.example.yaml config.yaml
6. 使用文本编辑器编辑
7. cd ..
8. go mod tidy
9. go get
10. go run main.go
11. 则服务器将运行于你所设定的端口上

API 接口文档

由于工期原因，API文档已经多个版本没有更新,现在不作为参考. 说明：

1. 下方文档中，参数和返回值使用了非标准的json语法格式。（标准的json中没有注释）
2. 所有请求使用json格式，请注意Json格式和PostForm的区别。可以参考：https://www.jianshu.com/p/d0a4de05786b
3. 部分指令需要认证：在Header 中 Authorization中传入 jwt 以认证 如果认证不成功则返回401错误以及

   {
       "status" : "unauthorized"
   }
   

   如果有其他错误则返回500。

1. [请求] Login 登陆请求

url: /api/login method: POST params:

{
    'emailPhone' = string, // 电子邮箱或是电话号码
    'method' = int,
    // 0 -- 使用电子邮箱登陆
    // 1 -- 使用电话号登陆
    'pwd' = 'string' // 密码，使用MD5进行哈希加密。
}

return values:

{

    'status' : int,
    // status   解释           状态码
    // 0        成功           200
    // -1       查无此人        406
    // -2       密码错误        406
    // -100     其他错误        400
    'jwt' : string
    // 作为登陆凭证，48小时有效，请前端使用cookie等方式保存，大多数请求将使用jwt进行验证。
    // 登陆失败则返回空值
}

2. [请求] 注册

url: /api/register method : POST params:

{
    "email" : string, // 电子邮箱地址
    "phone" : string, // 电话号码
    "type"  : int,  // 用户类型
    // 0 for 志愿者
    // 1 for 子女
    "pwd"   : string // 密码，使用MD5进行哈希加密
}

return values:

{
    "status" : int  // 返回状态
    // 0 for 成功
    // -1 for 存在此用户
    // -100 其他原因
}

注：注册不包括登陆，请注册完毕后再调用登陆API。

3. 获取用户信息

url: /api/user/info method: GET params: 不需要传入参数

return values:

{
    "status"        : int, 
    // 返回值        意义
    // 0            success
    // -100         其他错误
    "name"          : string,
    "email"         : string,
    "phone"         : string,
    "avatar_url"    : string,
    "type"          : int,
    "profile"       : string,
}

4. 修改用户信息

需要用户认证 url : /api/user/edit method : POST params:

{
    "name" : string,  // 用户名
    "email" : string,  // 电子邮件
    "phone" : string,  // 电话号
    "profile" : string  // 简介
}

return values:

{
    "message" : ok/ wrong request/ server error
}

200 for ok 400 for wrong request 500 for server error

5. 上传头像

注意和修改用户信息不同，上传头像是另外的。 上传头像后，原头像不保留。

url: /api/upload/avatar 使用Post File 方式传文件 返回文件的相对地址，可以访问。

6. 发布任务

url: /api/task/new method: POST` 需要用户认证 params:

{
    "content": string, // 任务内容
    "address": string, // 任务地点
    "require": int // 需要人数
    "time_start" : string  // 开始时间
    "time_end" : string     // 结束时间
    // 时间格式： 注意！必须使用规定的时间格式：
    // "2020-01-01 15:00:00"
}

7. 获取全部任务列表

url: /api/task/list method : GET 不需要参数 返回

{
    "tasks":[
        {
            "ID" : int, //任务id
            "CreatedAt": string, //时间
            "content" : string ,//  任务内容
            "address" : string, //地址
            "require" : int //需要人数
            "accept" : // 已经接受人数
            "time_start" : string // 开始时间
            "time_end" : string // 结束时间
            // 时间格式同上
            "issuer_id": int // 发起人id
        }
    ]
}

8. 接受任务

url : /api/task/accept method : GET 需要认证 params :

{
    id : int, // 任务id
}

return :

{
    "message" : string // 返回信息
}

9. 完成任务

10. 邮箱验证

URL: /api/user/vertify method: GET 获取邮箱验证码

11. 验证码验证

URL:/api/user/vertify //同上 method: POST

{
    "vertify_code": // 6位邮箱验证码
}