【软件工程】Snug接口文档

标签：strong   start   table   参数   javascrip   rip   创建   ref   flag   

目录

1. 登入

接口功能

实现用户登入功能

URL

http://47.95.240.12/api/login

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
telephone	ture	string	手机号
password	true	string	密码

返回字段

返回字段	字段类型	说明
msg	string	返回结果状态。ok：正常；false：错误。
name	string	用户名
telephone	string	用户手机号
id	int	用户ID

接口示例

//请求
{
    "telephone":"111",
    "password":"111"
}

//返回
{
    "msg": "ok",
    "data": {
        "name": "cqq",
        "telephone": "111",
        "id": 12
    }
}

2. 注册

接口功能

实现用户注册功能

URL

http://47.95.240.12/api/register

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
name	ture	string	用户名
telephone	true	string	用户手机号
password	true	string	用户密码

返回字段

返回字段	字段类型	说明
msg	string	返回结果状态。ok：正常；false：错误。

接口示例

//请求
{
    "name":"test",
    "telephone":"1323591088",
    "password":"111"
}

//返回
{
    "msg": "ok"
}

3. 用户信息

接口功能

获取用户信息

URL

http://47.95.240.12/api/userInfo

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
userId	ture	string	用户ID

返回字段

返回字段	字段类型	说明
msg	string	返回结果状态。ok：正常；false：错误。
name	string	用户名
telephone	string	用户手机号
id	int	用户ID

接口示例

//请求
{
    "userId":"13"
}

//返回
{
    "msg": "ok",
    "data": {
        "name": "cqqq",
        "telephone": "1111",
        "id": 13
    }
}

4. 用户自定义任务

接口功能

创建用户自定义的任务

URL

http://47.95.240.12/api/addTask

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
info	ture	string	任务内容
start	true	string	任务开始时间
end	true	string	任务结束时间
userId	true	int	用户ID

返回字段

返回字段	字段类型	说明
msg	string	返回结果状态。ok：正常；false：错误。

接口示例

//请求
{
    "info":"多健身",
    "start":"2019-02-26 23:59:59",
    "end":"2019-02-27 23:59:59",
    "userId":"2"
}

//返回
{
    "msg": "ok"
}

5. 查看任务

接口功能

查看用户当前任务

URL

http://47.95.240.12/api/viewTask

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
userId	ture	int	用户ID
date	true	string	选择查看任务时间

返回字段

返回字段	字段类型	说明
msg	string	返回结果状态。ok：正常；false：错误。
score	int	任务分数
taskFlag	string	任务标识
start	string	开始时间
end	string	结束时间
taskInfo	string	任务信息
taskId	int	任务ID
status	string	任务状态
userId	int	任务ID

接口示例

//返回
{
    "userId":1,
    "date":"2016-01-26 00:00:00"
}

//返回
{
    "msg": "ok",
    "data": [
        {
            "score": 0,
            "taskFlag": "1",
            "start": "2016-01-26 03:59:59",
            "end": "2016-01-27 03:59:59",
            "taskInfo": "笑一笑",
            "taskId": 5,
            "status": "0"
        },
        {
            "score": 0,
            "taskFlag": "1",
            "start": "2016-01-26 23:59:59",
            "end": "2016-01-27 23:59:59",
            "taskInfo": "drind 水",
            "taskId": 1,
            "status": "0"
        }
    ],
    "userId": 1
}

6. 待定

接口功能

创建用户自定义的任务

URL

http://47.95.240.12/api/addTask

支持格式

JSON

HTTP请求方式

POST

请求参数

参数	必选	类型	说明
info	ture	string	任务内容
start	true	string	任务开始时间
end	true	string	任务结束时间
userId	true	int	用户ID

返回字段

返回字段	字段类型	说明
msg	string	返回结果状态。ok：正常；false：错误。

接口示例

//请求
{
    "info":"多健身",
    "start":"2019-02-26 23:59:59",
    "end":"2019-02-27 23:59:59",
    "userId":"2"
}

//返回
{
    "msg": "ok"
}

【软件工程】Snug接口文档

标签：strong   start   table   参数   javascrip   rip   创建   ref   flag   

原文地址：https://www.cnblogs.com/shijinhai/p/11915243.html