Skip to content

Latest commit

 

History

History
691 lines (566 loc) · 9.25 KB

前端接口文档.md

File metadata and controls

691 lines (566 loc) · 9.25 KB
Raw

前端接口文档

登录模块

获取头像

  • 请求方式：get

  • url地址: /login/getAvatar

要求请求数据

// url地址携带用户名
{
    username: xxx
}

请求成功

{
    code: 0,  // 0为成功
    msg: '',  // 获取头像无响应信息
    data: {
        avatar: 'https://zos.alipayobjects.com/rmsportal/ODTLcjxAfvqbxHnVXCYX.png' // 返回头像地址
    }
}

请求失败（用户没有设置头像）

{
    code: 1,
    msg: '', // 无需显示错误信息
    data: {} /
}

登录

  • 请求方式: post
  • 请求地址: /login

要求请求数据

{
    username: xxx,
    password: xxx
}

请求成功

{
    code: 0,
    msg: '登录成功'，
    data： {
        // 这里数据包括后端生成的token 以及用户全部信息，除了密码，用于显示在个人中心
    }
}

请求失败（用户名或者密码错误）

{
    code: 1,
    msg: '登录失败，用户名或密码错误',
    data: {
        // 无
    }
}

使用token登录

  • 请求方式: post
  • 请求地址: /check_token

请求数据

{
    token: '...'
}

请求成功（token正确）

{
    code: 0,
    msg: '', // 正确不用返回信息
    data: {
        // 用户全部信息，包括token，不返回密码
    }
}

请求失败（如果token过期或者错误就代表请求失败）

{
    code: 1,
    msg: '', // 不用返回错误信息
    data: {
        // 无数据，需要用户前往登录
    }
}

获取系统flag

  • 请求方式: post
  • 请求地址: /getFlags

请求数据 /getFlags?page=1&offset=6 类似翻页

请求成功

{
    code: 0,
    msg: '', // 正确不用返回信息
    data: [..]  //返回flag列表  每次6个 
}

请求失败

{
    code: 1,
    msg: '', // 不用返回错误信息
    data: {}
}

获取要打卡的任务

  • 请求方式: get
  • 请求地址: /getTasks?token=xxx

请求数据 /getFlags?token=xxx

请求成功

{
    code: 0,
    msg: '', // 正确不用返回信息
    data: [
        {
            (键名看你怎么设置)id:xxx,
            title: xxx,
            content: xx,
            is_true: xx
        }
    ]  //返回要打卡的任务列表 
}

请求失败

{
    code: 1,
    msg: '', // 不用返回错误信息
    data: {}
}

添加flag到打卡

  • 请求方式: post
  • 请求地址: /addFlag

系统打卡 请求数据

{
    token: '...',
    id: xxx  // flag的id,
}

自定义打卡请求数据

{
    token: '...',
    flag_title: xxx,
    flag_content: xxx
}

两种情况在一个接口处理

请求成功

{
    code: 0,
    msg: '添加成功', 
    data: {
        // 返回添加的flag信息，包括id
    }
}

请求失败

{
    code: 1,
    msg: '添加失败', 
    data: {}
}

点击打卡

  • 请求方式: post
  • 请求地址: /punchFlag

请求成功

{
    code: 0,
    msg: '打卡成功',
    data: {
       
    }
}

请求失败

{
    code: 1,
    msg: '打卡失败', 
    data: {}
}

修改昵称

  • 请求方式: post
  • 请求地址: /profile/modifyNickname

请求数据 { nickname:xxx, token:xxx }

请求成功

{
    code: 0,
    msg: '修改成功', 
    data: {}
}

请求失败

{
    code: 1,
    msg: '修改失败', 
    data: {}
}

检查原密码是否正确

  • 请求方式: post
  • 请求地址: /profile/checkPrepass 请求数据
{
    prePass: xxx,
    token:xxx
}

请求成功

{
    code: 0,
    msg: '', 
    data: {}
}

请求失败

{
    code: 1,
    msg: '原密码错误', 
    data: {}
}

修改密码

  • 请求方式: post
  • 请求地址: /profile/modifyPassword 请求数据
{
    newPass: xxx,
    token:xxx
}

请求成功

{
    code: 0,
    msg: '修改成功', 
    data: {}
}

请求失败

{
    code: 1,
    msg: '修改失败，(说明下失败的原因)', 
    data: {}
}

获取总结打卡列表

  • 请求方式: post
  • 请求地址: /getDailyPunch 请求数据
{
    page:xxx
}

请求成功

{
    code: 0,
    msg: '', 
    data: {
        items: [
            {
                id:xx,
                userName:xx,
                avatar:xx,
                title:xx,
                content:xx,
                ...其他
            },
            {
                id:xx,
                userName:xx,
                avatar:xx,
                title:xx,
                content:xx,
                ...其他
            },
                        {
                id:xx,
                userName:xx,
                avatar:xx,
                title:xx,
                content:xx,
                ...其他
            }
        ],
        page（当前页）:xx
    }
}

请求失败

{
    code: 1,
    msg: '', 
    data: {}
}

发表总打卡

  • 请求方式: post
  • 请求地址: /dailyPunch 请求数据
{
    title: xxx,  // 标题
    content: xxx, // 内容
    token: xxx
}

请求成功

{
    code: 0,
    msg: '发表成功', 
    // 返回完整的总结打卡信息，会添加到下面的总结打卡列表中
    data: {
        id:xx,
        userName:xx,
        avatar:xx,
        title:xx,
        content:xx,
        agree：xx,
        comment_num:xx
    }
}

请求失败

{
    code: 1,
    msg: '发表失败', 
    data: {}
}

根据id获取总结打卡内容

  • 请求方式: get
  • 请求地址: /getDetailById 请求数据
{
    id(daily_punch_id):xxx
}

请求成功

{
    code: 0,
    msg: '', 
    data: {
        id:xx,
        userName:xx,
        avatar:xx,
        title:xx,
        content:xx,
        agree：xx,
        comment_num: xx
    }
}

请求失败

{
    code: 1,
    msg: '', 
    data: {}
}

根据id获取评论列表

  • 请求方式: get
  • 请求地址: /getComments 请求数据
{
    id(daily_punch_id):xxx,
}

请求成功

{
    code: 0,
    msg: '', 
    data: [
        {
            comment_id:xx,
            daily_punch_id:xx,
            .....
            ....
        },
        {
            comment_id:xx,
            daily_punch_id:xx,
            .....
            ....
        }
        ...
    ]
}

请求失败

{
    code: 1,
    msg: '', 
    data: {}
}

发表评论

  • 请求方式: post
  • 请求地址: /comment 请求数据
{
    comment_content:xxx,
    id(daily_punch_id):xxx,
    parent_id: xxx  // 如果不为空表示回复某人，否则表示普通评论
}

请求成功

{
    code: 0,
    msg: '评论成功', 
    // 返回完整评论信息
    data: {
        comment_id:xx,
        daily_punch_id:xx,
        .....
        ....
    }
}

请求失败

{
    code: 1,
    msg: '评论失败', 
    data: {}
}

获取文章列表

  • 请求方式: get
  • 请求地址: /getArticles 请求数据
{
    无
}

请求成功

{
    code: 0,
    msg: '', 
    data: [
        {
            id: Random.string('lower', 10),
            nickname: `立个Flag`,
            avatar: 'https://zos.alipayobjects.com/rmsportal/ODTLcjxAfvqbxHnVXCYX.png',
            title: '2018 年终总结：成就不算少，进步不算多',
            content: '最近一段时间没有更新原创文章了，主要是因为最近整个在忙硕士毕业的各种事情，毕业答辩完了以后休假了一小段时间，整个十二月就这么过去了。 转眼已经 2019 年了，其实去年我并没有写年终总结，现在到头来还是蛮后悔的，说实话总结其实还是蛮有必要的，现在就趁着这个时间来对自己的 2018',
            agree: 100,
            comment_num:111,
            date: '2019-4-27',
            image: xxx
        },
        {
            id: Random.string('lower', 10),
            nickname: `立个Flag`,
            avatar: 'https://zos.alipayobjects.com/rmsportal/ODTLcjxAfvqbxHnVXCYX.png',
            title: '2018 年终总结：成就不算少，进步不算多',
            content: '最近一段时间没有更新原创文章了，主要是因为最近整个在忙硕士毕业的各种事情，毕业答辩完了以后休假了一小段时间，整个十二月就这么过去了。 转眼已经 2019 年了，其实去年我并没有写年终总结，现在到头来还是蛮后悔的，说实话总结其实还是蛮有必要的，现在就趁着这个时间来对自己的 2018',
            agree: 100,
            comment_num:111,
            date: '2019-4-27',
            image: xxx
        },
    ]
}

请求失败

{
    code: 1,
    msg: '', 
    data: {}
}

上传头像

  • 请求方式: post
  • 请求地址: /setFlag/uploadAvatar 请求数据
{
    // 一个文件
}

请求成功

{
    code: 0,
    msg: '上传成功', 
    data: {} //无
}

请求失败

{
    code: 1,
    msg: '上传失败', 
    data: {}
}

上传图片

  • 请求方式: post
  • 请求地址: /setFlag/uploadImg 请求数据
{
    // 一个文件
}

请求成功

{
    code: 0,
    msg: '上传成功', 
    data: {
        image:xxx // 后端存储到服务器后返回图片地址
    } 
}

请求失败

{
    code: 1,
    msg: '上传失败', 
    data: {}
}