README.md

Jinghong-LoveWall

精弘表白墙项目 是精弘网络技术部 试用期项目

项目介绍

前端一坨屎 本项目采用vue.js+jquery+bootstrap5 感谢枫寒和node对本项目的大力支持

如何使用？

0. clone下来
1. 打开frontend文件夹
2. 编译一下后端或者直接下载编译好的exe在cmd里用命令行打开exe文件(请将exe放在后端源代码的目录中不然会有奇怪的bug)
3. 安装cors之类的浏览器插件使浏览器支持跨域

如何使用后端测试？

0. 安装好Go 1.13

1. clone整个项目

   git clone [email protected]:Forever-Jimmy/Jinghong-LoveWall.git
   

2. 进入项目根目录，也就是main.go文件所在的目录。

3. 执行:

   go run main.go
   

默认端口为8080 可以使用localhost:8080访问

例如要实现用户注册 向localhost:8080/api/registerPOST即可

API

[1] [用户注册] [POST]

URL: domain:port/api/register

传入数据

{
    "email" : "[email protected]", // 电子邮件地址
    "username" : "node520",  // 用户昵称
    "password" : "5AA765D61D8327DE"  // 用户密码，用MD5（16位大写）加密，样例所示为"password"加密后的密文
}

返回数据

{
    "return_value": 0 // 表示用户注册成功
                    -1 // 表示用户已存在（电子邮件已经注册）
                    -2 // 表示服务器错误
                    -3 // 表示请求错误
}

[2] [用户登录] [POST]

URL: domain:port/api/login

传入数据

{
    "email" : "[email protected]", // 电子邮件地址
    "password" : "5AA765D61D8327DE"  // 用户密码
}

返回数据

{
    "return_value" : 0, // 登录成功
                     -1, // 用户不存在
                     -2, // 密码错误
                     <!-- -3, // 重复登录 -->
                     -4, // 服务器错误
                     -5, // 重复登录
                     -6, // 参数错误
    "token" : "xxxx" // token 客户端保存，需要token时需要上传。如果登录失败，返回的token是空
}

[3] 用户登出 [POST]

URL: domain:port/api/logout

传入数据

{
    "token" : "xxx"  // 传入token
}

返回数据

{
    "return_value" : 0 // 成功登出
                     -1 // 参数错误
                     -2 // 服务器错误
                     -3 // token错误

}

[4] [新建信息] [POST]

URL: domain:port/api/new_message

传入数据

{
    "token" : "xxx",
    "content" : "内容"  // 信息内容
    "anonymous": 0  // 不匿名
                 1  // 匿名
    "permit_comment" : 0 // 不允许评论
                       -1 // 允许评论
}

{
    "return_value" : 0 // 成功
                     -1 // 参数错误
                     -2 // token错误
                     -3 // 服务器错误

}

[5] 获取指定的信息 [GET]

URL: domain:port/api/message

传入数据

{
    "id": "1" // 传入信息的id
}

返回数据

{
    "return_value" : 0 // 成功
                     -1 // 请求错误
                     -2 // 服务器错误
                     -3 // 无该信息
    "uid" : 0 // 0 表示该信息是匿名的，防止泄露，客户端无法得知信息的用户
    "content" : "内容" // 信息的内容
    "permit_comment" : 0 // 不允许评论
                       1 // 允许评论
    "create_time"  // 创建时间
    "update_time" // 更新时间
    "like" :  // 返回一个列表，点赞的人
    "comment_id" : // 返回评论id列表

    <!-- ! 评论暂没有实现 -->

}

[6] 随机取一个信息 [GET]

URL:domain:port/api/message/random

传入数据

不需要

返回数据

{
    "return_value" : 0 // 成功
                     -1 // 服务器错误
    "id" : 123 // 文章的id
}

获取内容使用[5]

[7] 修改信息 [POST]

URL:domain:port/api/message

传入数据

{
    "id" : 123 // 文章的id
    "token" : // 你的token
    "content" : "文章信息"  // 文章信息
    "permit_comment" : 
    "anonymous": 
}

传出数据

{
    "return_value" : 0 // 成功
                     -1 // 参数错误
                     -2 // token 错误 （没有登录）
                     -3 // 服务器错误
}

[8] 删除信息 [POST]

URL:domain:port/api/message/delete

传入数据

{
    "id" : // 信息的id
    "token" : // 用户的token
}

传出数据

{
    "return_value" : 0 // 成功
                     -1 // 参数错误
                     -2 // token错误
                     -3 // 服务器错误
}

[9] 点赞 [POST]

URL:domain:port/api/message/like

传入数据

{
    "id": // 文章的id
    "token" : // 你的token
}

传出数据

{
    "return_value" : 0 // 成功
                     -1 // 参数错误
                     -2 //服务器错误
                     -3 // token错误
}