Monstargram_backend - PasseroChloe/web GitHub Wiki

Monstargram-backend

本项目为Monstargram网站的后端，包含了所有的接口，服务框架为Django。

接口文档

#目录

注册，登陆，获取用户列表，获取用户详细信息，修改用户信息，删除用户，获取资源列表，上传资源，获取评论列表，评论，获取点赞列表，点赞，取消点赞。

注册

接口调用请求说明

HTTP请求方式：post 请求数据格式：Content Type: application/json URL: //example.com/user_list/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
email Y varchar 邮箱
phone_number N varchar 电话
返回说明

正常时的返回JSON数据包

{
    "id": 14,
    "email": "[email protected]",
    "username": "Wangba",
    "password": "wangba",
    "phone_number": "17968902356"
}

登录

接口调用请求说明

HTTP请求方式：post 请求数据格式：Content Type: application/json URL: //example.com/login/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
返回说明

正常时的返回JSON数据包

{
    "status": 1,
    "message": "Login successfully!",
    "data": {
        "user_id": 14,
        "username": "Wangba",
        "user_phone_number": "17968902356",
        "user_email": "[email protected]"
    }
}

获取用户列表

接口调用请求说明

HTTP请求方式：get 请求数据格式：Content Type: application/json URL: //example.com/user_list/

请求参数
无
返回说明

正常时的返回JSON数据包

[
    {
        "id": 14,
        "email": "[email protected]",
        "username": "Wangba",
        "phone_number": "17968902356"
    },
    ...
]

获取用户详细信息

接口调用请求说明

HTTP请求方式：get 请求数据格式：Content Type: application/json URL: //example.com/user_detail/id/

请求参数
返回说明

正常时的返回JSON数据包

{
    "id": 14,
    "email": "[email protected]",
    "username": "Wangba",
    "phone_number": "17968902356",
    "resources": [
        {
            "id": 24,
            "resource_title": "wangba_1",
            "resource_image": "640x452-21.jpeg",
            "upload_time": "2017-11-23T08:02:53Z"
        },
        {
            "id": 26,
            "resource_title": "wangba_2",
            "resource_image": "640x452-22.jpeg",
            "upload_time": "2017-11-23T08:03:54Z"
        },
        {
            "id": 27,
            "resource_title": "wangba_3",
            "resource_image": "640x452-23.jpeg",
            "upload_time": "2017-11-23T08:04:20Z"
        },
        {
            "id": 28,
            "resource_title": "wangba_4",
            "resource_image": "640x452-24.jpeg",
            "upload_time": "2017-11-23T08:04:38Z"
        }
    ]
}

修改用户信息

接口调用请求说明

HTTP请求方式：put 请求数据格式：Content Type: application/json URL: //example.com/user_list/id/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
email Y varchar 邮箱
phone_number N varchar 电话
返回说明

正常时的返回JSON数据包

{
    "id": 14,
    "email": "[email protected]",
    "username": "Wangba",
    "password": "wangjiu",
    "phone_number": "17968902356"
}

删除用户

接口调用请求说明

HTTP请求方式：delete 请求数据格式：Content Type: application/json URL: //example.com/user_list/id/

请求参数

无

返回说明

正常时的返回JSON数据包

获取资源列表

接口调用请求说明

HTTP请求方式：get 请求数据格式：Content Type: application/json URL: //example.com/resource_list/

请求参数

无

返回说明

正常时的返回JSON数据包

[
    {
        "id": 28,
        "author": "Wangba",
        "resource_title": "wangba_4",
        "resource_image": "640x452-24.jpeg",
        "upload_time": "2017-11-23T08:04:38Z",
        "likes_num": 0,
        "comment": []
    },
    {
        "id": 27,
        "author": "Wangba",
        "resource_title": "wangba_3",
        "resource_image": "640x452-23.jpeg",
        "upload_time": "2017-11-23T08:04:20Z",
        "likes_num": 0,
        "comment": []
    },
    {
        "id": 26,
        "author": "Wangba",
        "resource_title": "wangba_2",
        "resource_image": "640x452-22.jpeg",
        "upload_time": "2017-11-23T08:03:54Z",
        "likes_num": 0,
        "comment": []
    },
    {
        "id": 24,
        "author": "Wangba",
        "resource_title": "wangba_1",
        "resource_image": "640x452-21.jpeg",
        "upload_time": "2017-11-23T08:02:53Z",
        "likes_num": 0,
        "comment": []
    },
    ...
]

上传资源

接口调用请求说明

HTTP请求方式：post 请求数据格式：Content Type: application/json URL: //example.com/user_list/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
email Y varchar 邮箱
phone_number N varchar 电话
返回说明

正常时的返回JSON数据包

{
    "id": 14,
    "email": "[email protected]",
    "username": "Wangba",
    "password": "wangba",
    "phone_number": "17968902356"
}

获取评论列表

接口调用请求说明

HTTP请求方式：get 请求数据格式：Content Type: application/json URL: //example.com/comment_list/

请求参数

无

返回说明

正常时的返回JSON数据包

[
    {
        "id": 14,
        "author": "Wangba",
        "resource": "wangba_1",
        "content": "Wow!",
        "comment_time": "2017-11-23T08:20:56Z"
    },
    ...
]

评论

接口调用请求说明

HTTP请求方式：post 请求数据格式：Content Type: application/json URL: //example.com/user_list/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
email Y varchar 邮箱
phone_number N varchar 电话
返回说明

正常时的返回JSON数据包

{
    "id": 14,
    "email": "[email protected]",
    "username": "Wangba",
    "password": "wangba",
    "phone_number": "17968902356"
}

获取点赞列表

接口调用请求说明

HTTP请求方式：get 请求数据格式：Content Type: application/json URL: //example.com/user_likes_list/

请求参数

无

返回说明

正常时的返回JSON数据包

[
    {
        "id": 21,
        "user": "Wangba",
        "resource": "wangba_2",
        "update_time": "2017-11-23T08:22:56Z"
    },
    ...
]

点赞

接口调用请求说明

HTTP请求方式：post 请求数据格式：Content Type: application/json URL: //example.com/likes/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
email Y varchar 邮箱
phone_number N varchar 电话
返回说明

正常时的返回JSON数据包

{
    "status": 1,
    "message": "Likes operation completed successfully!"
}

取消点赞

接口调用请求说明

HTTP请求方式：post 请求数据格式：Content Type: application/json URL: //example.com/cancel_likes/

请求参数
参数名 必填 数据类型 说明
username Y varchar 用户名
password Y varchar 密码
email Y varchar 邮箱
phone_number N varchar 电话
返回说明

正常时的返回JSON数据包

{
    "status": 1,
    "message": "Cancel likes operation completed successfully!"
}