9PM Online Teaming Platform -backend

About The Project

9PM Online Teaming Platform——Fronted

This project is the backend of the 9PM Online Teaming Platform for Unicode Hackathon. 9PM Online Teaming Platform aims to facilitate game teaming for international students from China in this self-quarantine period and further.

Built With

• Maven - Dependency Management
• Spring Boot - Server Framework
• Shiro - Security Framework
• MyBatis - Persistence Framework
• MyBatis-plus - MyBatis plus plus
• MySQL - Database
• fastjson - Parse JSON Object

Quick Start

Prerequisites

• MySQL

Installation guide:

https://www.runoob.com/mysql/mysql-install.html

Establish develop environment data

create table room
(
    id         int auto_increment
        primary key,
    date_time  varchar(255) null,
    game_name  varchar(255) null,
    max_number int          null,
    host_id    int          not null,
    members_id varchar(255) null
);
INSERT INTO unicodesc.room (id, date_time, game_name, max_number, host_id, members_id) VALUES (1, '2020-9-5-20-00', 'lol', 5, 1, '2,3');
INSERT INTO unicodesc.room (id, date_time, game_name, max_number, host_id, members_id) VALUES (2, '2020-1-1-0-0', 'pubg', 4, 2, null);
INSERT INTO unicodesc.room (id, date_time, game_name, max_number, host_id, members_id) VALUES (3, '2020-02-1420-10', 'lol', 5, 1, null);
create table user
(
    id           bigint auto_increment
        primary key,
    email        varchar(64)                      null,
    password     varchar(255) collate utf8mb4_bin null,
    name         varchar(32)                      null,
    my_teams     varchar(255) collate utf8mb4_bin null,
    joined_teams varchar(255)                     null,
    sex          int                              null,
    roles        varchar(255)                     null
);
INSERT INTO unicodesc.user (id, email, password, name, my_teams, joined_teams, sex, roles) VALUES (1, 'abc@ucsd.edu', 'sss', 'Yui', '1,3', null, 0, null);
INSERT INTO unicodesc.user (id, email, password, name, my_teams, joined_teams, sex, roles) VALUES (2, 'yyu@ucsd.edu', 'sss', 'Yukino', '2', '1', 2, null);
INSERT INTO unicodesc.user (id, email, password, name, my_teams, joined_teams, sex, roles) VALUES (3, 'zzd@ucsd.edu', '123', 'zzd', null, '1', 0, null);

Installation

1. Clone the repo

   https://github.com/wfy0425/Unicode-Hackathon-backend.git

2. Package the Application

3. Run it

APIs

登陆

GET /login

Parameters

Responses

{
    "code": 200,
    "msg": "Login success",
    "data": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1OTkzMDk5NzgsInVzZXJuYW1lIjoiMTIzQGdtYWlsLmNvbSJ9.0i4g4K5IcOY5h2q9xYuYtG_sbkjkc5LwEilz9KM_YvQ"
}

{
    "code": 400,
    "msg": "username or password wrong",
    "data": null
}

注册

POST /register

Parameters

Responses

{
    "code": 201,
    "msg": "user registered",
    "data": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE1OTkzMTM0ODUsInVzZXJuYW1lIjoiYWJjQHVjc2QuZWR1In0.RrPSAM0iJi7GFAMMTgLbLZHPwjPdglmF5cHrWSTV3ug"
}

{
    "code": 400,
    "msg": "username already exist",
    "data": null
}

获取用户列表

GET /users

Responses

通过用户id获取用户信息

GET /users/{id}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": [
        {
            "id": 1,
            "email": "123@gmail.com",
            "password": "123",
            "name": "Adam",
            "myTeams": "1",
            "joinedTeams": "2",
            "sex": 1,
            "roles": null
        },
        ...
    ]
}

{
    "code": 401,
    "msg": "The current Subject is not authenticated.  Access denied.",
    "data": null
}

更新用户详细信息

PUT /users/{id}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": {
        "id": 17,
        "email": null,
        "password": null,
        "name": "Yukinoshita Yukino",
        "myTeams": null,
        "joinedTeams": null,
        "sex": 0,
        "roles": null
    }
}

{
    "code": 401,
    "msg": "The current Subject is not authenticated.  Access denied.",
    "data": null
}

Security

只能更新自己

将用户加入队伍

PUT /users/{teamId}/{userId}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": 1
}

{
    "code": 401,
    "msg": "Unauthorized",
    "data": null
}

从队伍中删除用户

DELETE /users/{teamId}/{userId}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": 1
}

创建队伍

POST /rooms

Parameters

Responses

{
    "code": 201,
    "msg": "CREATED",
    "data": {
        "id": 8,
        "dateTime": "2222",
        "gameName": "123",
        "maxNumber": 4,
        "hostId": 17,
        "membersId": null
    }
}

Security

只能创建以自己为房主的房间

获取队伍列表

GET /rooms

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": [
        {
            "id": 1,
            "dateTime": "2020-9-5-20-00",
            "gameName": "lol",
            "maxNumber": 5,
            "hostId": 1,
            "membersId": "17,17"
        },
        ...
    ]
}

通过房主id获取队伍信息

GET /rooms/host/{id}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": [
        {
            "id": 1,
            "dateTime": "2020-9-5-20-00",
            "gameName": "lol",
            "maxNumber": 5,
            "hostId": 1,
            "membersId": "17,17"
        }
    ]
}

通过队伍id获取队伍信息

GET /rooms/{id}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": {
        "id": 1,
        "dateTime": "2020-9-5-20-00",
        "gameName": "lol",
        "maxNumber": 5,
        "hostId": 1,
        "membersId": "17"
    }
}

通过队伍id删除队伍

DELETE /rooms/{id}

Parameters

Responses

{
    "code": 200,
    "msg": "OK",
    "data": 1
}

Security

只能删除以自己为房主的房间

Authors

• Fengyuan Wu - Author - wfy0425

License

This project is licensed under the MIT License - see the LICENSE file for details

Acknowledgments

《深入浅出Spring Boot 2.x》 （杨开振）

Shiro + JWT + Spring Boot Restful 简易教程

使用Swagger2Markup实现API文档的静态部署