Skip to content

SunInfoFE/sunflower-note-server

BranchesTags

Repository files navigation

sunflower-note 周报管理平台-服务端文档

目录

结构树

.
├── index.js
├── common
│   └── utils
│       └── getMonday.js
├── config
│   └── default.js
├── controller
│   ├── group
│   │   ├── group.js
│   │   └── README.md
│   ├── report
│   │   ├── currentWeekReport.js
│   │   ├── groupReport.js
│   │   ├── myReport.js
│   │   └── README.md
│   └── user
│       ├── index.js
│       └── README.md
├── doc
│   └── sunflower-note.sql
├── lib
│   └── mysql.js
├── LICENSE
├── middlewares
│   ├── check.js
│   ├── logger.js
│   └── session.js
├── public
├── routers
│   ├── group.js
│   ├── index.js
│   ├── report.js
│   └── user.js
└── views

功能模块

  • 用户登录
  • 用户管理
  • 权限管理
  • 附件上传

接口文档

返回值格式

// 成功
{
    status: true,
    data: '成功数据'
}
// 失败
{
    status: false,
    data: '失败原因'
}

1. 注册

请求方式： POST
接口： /user/register
参数：

{
    name: 'user111',                    // 姓名
    sex: 'male/female/nuknow',          // 性别
    email: '[email protected]',       // 邮箱/账号
    remark: '备注',                     // 备注/个人说明
    groupId: 'groupID',                 // 所属组的id
    password: 'password',               // 登录密码
}

成功返回值：

{
    status: true,
    data: '注册成功'
}

2. 普通用户登录

请求方式： POST
接口： /user/login
参数：

{
    email: '[email protected]',           // 邮箱/账号
    password: 'password'                    // 密码
}

成功返回值：

{
    status: true,
    data: '登录成功'
}

2. 管理员登录

请求方式： POST
接口： /user/adminLogin
参数：

{
    email: '[email protected]',           // 管理员邮箱/账号
    password: 'password'                    // 密码
}

成功返回值：

{
    status: true,
    data: '登录成功'
}

2. 注销/退出系统

请求方式： GET
接口： /user/logOut
参数：

无

成功返回值：

{
    status: true,
    data: '系统已退出！'
}

获取用户信息

请求方式： GET
接口： /user/getUserInfo
参数：

无

成功返回值：

{
    status: true,
    data: [{
        email: '[email protected]',       // 邮箱/账号
        name: 'name',                       // 姓名
        sex: 'male/female/unknow',          // 性别 male(男)/female(女)/unknow(保密)
        remark: '备注说明',                  // 备注说明
        groupId: 'groupId',                 // 所属组id
        groupName: 'name'                   // 所属组组名
    }]
}

更改密码

请求方式： POST
接口： /user/changePassword
参数：

{
    oldPassword: 'oldPassword'                // 旧密码
    newPassword: 'newPassword'                // 要更改的新密码
}

成功返回值：

{
    status: true,
    data: '密码更改成功'
}

更改个人信息（只支持更改个人姓名、性别、备注说明信息）

请求方式： POST
接口： /user/changUserInfo
参数：

{
    name: 'name'                        // 要更改的新密码
    sex: 'male/female/unknow',          // 性别 male(男)/female(女)/unknow(保密)
    remark: '备注说明'                   // 备注说明
}

成功返回值：

{
    status: true,
    data: '个人信息更改成功！'
}

3. 本周周报（获取所有本周周报/新增/修改/删除）

3.1 获取所有本周周报

请求方式： GET
接口： /report/currentWeekReport/get
参数：

 无

成功返回值：

{
    status: true,
    data: [
        {
            id: id,                                           // 周报id
            title: '标题',                                    // 周报标题
            summary: '上周总结',                              // 上周总结
            plan: '下周计划',                                 // 下周计划
            createTime: '2018-03-05 16:50:21',               // 创建时间
            lastUpdateTime '2018-03-05 16:50:21',            // 上次更新时间
            week: '2018-03-05',                              // 周报所属周的周一日期
            status: 'private/public',                        // 周报状态  private(隐私/未提交) public(公开/已提交)
            email: '[email protected]'                     // 周报所属人员的email(邮箱/账号)
        },
        ...
    ]
}

3.2 新增

请求方式： POST
接口： /report/currentWeekReport/add
参数：

 {
    title: '标题',            // 标题
    summary: '内容',          // 本周总结
    plan: '内容'              // 下周计划
 }

成功返回值：

{
    status: true,
    data: '新增成功'
}

3.3 修改

请求方式： POST
接口： 、/report/currentWeekReport/edit
参数：

 {
    id: '周报ID',           // 修改的周报id
    title: '标题',          // 标题
    summary: '内容',        // 本周总结
    plan: '内容'            // 下周计划
 }

成功返回值：

{
    status: true,
    data: '修改成功'
}

3.4 删除/批量删除

请求方式： POST
接口： /report/currentWeekReport/delete
参数：

 {
    idList： ['周报ID',...]        //删除的周报id列表
 }

成功返回值：

{
    status: true,
    data: '删除成功'
}

3.4 提交周报（将本周周报中的一份提交至小组周报,一周只能提交一份）

请求方式： POST
接口： /report/currentWeekReport/submit
参数：

 {
    id：周报ID         // 要提交的周报id
 }

成功返回值：

{
    status: true,
    data: '提交成功'
}

3.5 撤销已经提交的周报（取消提交）

请求方式： POST
接口： /report/currentWeekReport/cancelSubmit
参数：

 {
    id：周报ID         // 要撤销提交的周报id
 }

成功返回值：

{
    status: true,
    data: '提交撤销成功'
}

4. 我的周报（获取周报（条件获取：年、第几周、是否已提交或所有）/获取周报详情/删除）

4.1 获取我的周报

请求方式： POST
接口： /report/myReport/get
参数：

 {
    ...
 }

成功返回值：

{
    status: true,
    data: [
        {
            title: '',
            ...
        }
        ...
    ]
}

4.2 删除/批量删除

请求方式： POST
接口： /report/myReport/delete
参数：

 {
    idList: ['周报ID',...]
 }

成功返回值：

{
    status: true,
    data: '删除成功'
}

5. 已提交的周报

5.1 获取当前用户所有已提交的周报

请求方式：GET
接口：/report/submitedReport/get
参数：

无

成功返回值：

{
    status: true,
    data: [
        {
            title: '',
            ...
        }
        ...
    ]
}

6. 小组周报

6.1 获取用户所在组所有已提交的周报

请求方式：GET
接口：/report/groupReport/get
参数：

无

成功返回值：

{
    status: true,
    data: [
        {
            title: '',
            ...
        }
        ...
    ]
}

7. 小组管理（获取所有小组/添加小组/编辑小组/删除小组（空小组可删除）/搜索用户）

7.1 获取所有小组

请求方式：GET
接口：/group/groupManage/get
参数：

无

成功返回值：

{
    status: true,
    data: [
        {
            id: 12,
            name: "afs",
            memberNum: 5,   // 人员数
            remark: "dfsf",  // 备注
            createTime: "2018-02-28T07:33:09.000Z"
        }
    ]
}

失败返回值：

{
    status: false,
    data: '查询失败，请重试！'
}

7.2 添加小组

请求方式：POST
接口：/group/groupManage/add
参数：

{
    name: '组名',
    remark: '备注（小组信息）'
}

成功返回值：

{
    status: true,
    data: '新增成功'
}

失败返回值：

{
    status: true,
    data: '新增失败，请重试！'
}

或

{
    status: true,
    data: '小组名已存在！！'
}

7.3 编辑小组

请求方式：POST
接口：/group/groupManage/edit
参数：

{
    id: 小组ID,
    name: '小组名'
    remark: '备注（小组信息）'
}

成功返回值：

{
    status: true,
    data: '编辑成功'
}

失败返回值：

{
    status: true,
    data: '编辑失败，请重试！'
}

或

{
    status: true,
    data: '小组名已存在！'
}

7.4 删除小组（空小组可删除）

请求方式：POST
接口：/group/groupManage/delete
参数：

{
    idList: [id1, id2, ...]
}

成功返回值：

{
    status: true,
    data: '删除成功'
}

失败返回值：

{
    status: true,
    data: '删除失败，请重试！'
}

或

{
    status: true,
    data: '小组人员不为空无法删除！'
}

7.5 查看小组内所有成员

请求方式：GET
接口：/group/groupManage/getGroupMember
参数：

{
    id: 小组ID
}

成功返回值：

{
    status: true,
    data: [{
        email: "[email protected]",
        name: "霍鸽",
        sex: "female",
        remark: "前端工程师",
        groupId: 12,  // 小组id
        password: "huog"
    }]
}

失败返回值：

{
    status: false,
    data: '查询小组成员失败，请重试！'
}

7.5.1 查看多个小组内所有成员

请求方式：��POST
接口：/group/groupManage/getGroupsMember
参数：

{
    idList: [id1, id2, ...]
}

成功返回值：

{
    status: true,
    data: [{
        email: "[email protected]",
        name: "霍鸽",
        sex: "female",
        remark: "前端工程师",
        groupId: 12,  // 小组id
        password: "huog"
    }]
}

失败返回值：

{
    status: false,
    data: '查询小组成员失败，请重试！'
}

7.6 删除组内人员

请求方式：POST
接口：/group/groupManage/deleteGroupMember
参数：

{
    idList: [id1, id2, ...]
}

成功返回值：

{
    status: true,
    data: '删除成功'
}

失败返回值：

{
    status: true,
    data: '删除失败，请重试！'
}

7.7 生成合并组

请求方式：POST
接口：/group/groupManage/editGroupsCombine
参数：

{
    idList: [id1, id2, ...],
    emailList: [email1,email2]
}

成功返回值：

{
    status: true,
    data: '编辑成功'
}

失败返回值：

{
    status: true,
    data: '编辑失败，请重试！'
}

{
    status: false,
    data: '无法完成操作，请检查传入参数是否正确！'
}

7.8 删除合并组记录

请求方式：POST
接口：/group/groupManage/deleteGroupsCombine
参数：

{
    idList: [id1, id2, ...],
    emailList: [email1,email2]
}

成功返回值：

{
    status: true,
    data: '删除成功'
}

失败返回值：

{
    status: false,
    data: '删除失败，请重试！'
}

{
    status: false,
    data: '无法完成操作，请检查传入参数是否正确！'
}

8 本周日志

8.1 获取用户本周所有日志

请求方式：GET
接口：/journal/currentWeekJournal/getAll
参数：

无

成功返回值：

{
    status: true,
    data: [
        {
            id: 日志id,
            task: 日志内容,
            createTime: 创建时间,
            email: 用户email,
            week: 日志所在周一日期（周标志）,
            status: 日志状态 ('unfinished' / 'finished')
        }
        ...
    ]
}

失败返回值：

{
    status: false,
    data: err.message
}

8.2 新增本周工作日志

请求方式：POST
接口：/journal/currentWeekJournal/add
参数：

{
    task: 日志内容日志内容日志内容
}

成功返回值：

{
    status: true,
    data: '新增成功！'
}

失败返回值：

{
    status: false,
    data: err.message
}

8.3 编辑本周工作日志

请求方式：POST
接口：/journal/currentWeekJournal/edit
参数：

{
    id: 日志id,
    task: 修改后的日志内容
}

成功返回值：

{
    status: true,
    data: '编辑成功！'
}

失败返回值：

{
    status: false,
    data: err.message
}

8.4 修改工作日志状态（未完成/已完成）

请求方式：POST
接口：`/journal/currentWeekJournal/changeStatus
参数：

{
    id: 日志id,
    status: 修改后的状态 ('unfinished' / 'finished')
}

成功返回值：

{
    status: true,
    data: '状态修改成功！'
}

失败返回值：

{
    status: false,
    data: err.message
}

8.5 将所选'工作日志'形成的预览周报，保存为周报草稿

请求方式：POST
接口：/journal/currentWeekJournal/saveDraft
参数：

{
    title: 周报标题,
    summary: 本周总结,
    plan: 下周计划
}

成功返回值：

{
    status: true,
    data: '保存成功，可在"我的周报"中查看！'
}

失败返回值：

{
    status: false,
    data: err.message
}

8.6 将所选'工作日志'形成的预览周报，直接提交至小组周报

请求方式：POST
接口：/journal/currentWeekJournal/submitDraft
参数：

{
    title: 周报标题,
    summary: 本周总结,
    plan: 下周计划
}

成功返回值：

{
    status: true,
    data: '已提交至小组周报！'
}

失败返回值：

{
    status: false,
    data: err.message
}

8.7 删除工作日志

请求方式：POST
接口：/journal/currentWeekJournal/delete
参数：

{
    idList: [id,...]
}

成功返回值：

{
    status: true,
    data: '删除成功！'
}

失败返回值：

{
    status: false,
    data: err.message
}

系统设置

管理员系统设置

请求方式：POST
接口：/system/setSysSetting
参数：

{
    emailSuffix: '@suninfo;@qq;@163',       // 注册邮箱后缀(字符串，英文;分隔)
    sysAnnouncement: '111;222;333',         // 系统公告(字符串，英文；分隔)
    timeOut: 600(Number)                    // 系统超时时间（单位：秒，默认600s）
}

成功返回值：

{
    status: true,
    data: '保存成功！'
}

失败返回值：

{
    status: false,
    data: err.message
}

获取系统设置

请求方式：GET
接口：/system/getSysSetting
参数：

{
    无
}

成功返回值：

{
    status: true,
    data: {
        emailSuffix: '@suninfo;@qq;@163',       // 注册邮箱后缀(字符串，英文;分隔)
        sysAnnouncement: '111;222;333',         // 系统公告(字符串，英文；分隔)
        timeOut: 600(Number)                    // 系统超时时间（单位：秒，默认600s）
    }
}

失败返回值：

{
    status: false,
    data: err.message
}

v2.0.0新增接口

发送周报邮件接口

请求方式：POST
接口：/report/groupCurrentWeekReport/sendMail
参数：

{
    to: ['[email protected]', ...]',      // 收件人
    cc: ['[email protected]', ...]',      // 抄送给
    title: '标题',
    content: '正文内容'
}

成功返回值：

{
    status: true,
    data: '邮件已发送，您可登录邮箱查看！'
}

失败返回值：

{
    status: false,
    data: '邮件发送失败失败，请重试！'
}

重新发送激活邮件接口

请求方式：POST
接口：/user/resendActiveEmail
参数：

{
    email: '[email protected]'             // 用户注册邮箱（接收激活邮件的邮箱）
}

成功返回值：

{
    status: true,
    data: '账号激活邮件已发送到您的注册邮箱，请尽快激活账号！'
}

失败返回值：

{
    status: false,
    data: '邮件发送失败，请重试！'
}

新增发送邮件用户

请求方式：POST
接口：/user/addSendMailUser
参数：

{
    email: '[email protected]',       // 用户邮箱
    name: '张三'                   // 用户姓名
}

成功返回值：

{
    status: true,
    data: '新增成功！'
}

失败返回值：

{
    status: false,
    data: '该邮箱已添加，请勿重复添加！'
}
或
{
    status: false,
    data: '新增失败，请重试！'
}

删除发送邮件用户

请求方式：POST
接口：/user/deleteSendMailUser
参数：

{
    emailList: ['[email protected]', ...]           // 要删除的用户邮箱列表
}

成功返回值：

{
    status: true,
    data: '删除成功！'
}

失败返回值：

{
    status: false,
    data: '删除失败，请重试！'
}

获取发送邮件用户

请求方式： GET
接口：/user/getSendMailUser
参数：

{
    无
}

成功返回值：

{
    status: true,
    data: [{
        email: '',      // 邮箱
        name: ''        // 姓名
    }, ...]
}

失败返回值：

{
    status: false,
    data: '获取数据失败，请重试！'
}

更新/编辑发送邮件用户

请求方式： POSt
接口：/user/updateSendMailUser
参数：

{
    email: '[email protected]',
    name: '新李四',
    id: '用户对应的id'
}

成功返回值：

{
    status: true,
    data: '更新成功！'
}

失败返回值：

{
    status: false,
    data: '更新失败，请重试！'
}

移动一个组的成员到另一组

请求方式： POST
接口：/group/groupManage/moveGroupMember
参数：

{
    emailList: ['[email protected]', '[email protected]', ...],   // 要移动的人员email列表
    groupId: groupId        // 移动的目标组的id
}

成功返回值：

{
    status: true,
    data: '移动成功！'
}

失败返回值：

{
    status: false,
    data: '移动失败，请重试！'
}

用户签到

请求方式：POST
接口：/punchcard/signin
参数：

{
    userid: '[email protected]'
}

成功返回值：

{
    status: true,
    data: '签到成功！'
}

失败返回值：

{
    status: false,
    data: '已签到！'
}
{
    status: false,
    data: '签到失败，请重试！'
}

用户签到列表

请求方式：POST
接口： /punchcard/userList
参数：

{
    userid: '[email protected]'
}

成功返回值：

{
    status: true,
    data: [{card_time: "2018-9-10", card_status: 1}]
}

失败返回值：

{
    status: false,
    data: '操作失败，请重试！'
}

所有用户签到信息

请求方式： POST
接口：/punchcard/allList
参数：

成功返回值：

{
    status: true
    data: [{userid: "asdfasdf", card_time: "2018-9-10", card_status: 1}]
}

失败返回值：

{
    status: false,
    data: '操作失败，请重试！'
}

当月所有用户的签到信息

请求方式： POST
接口：/punchcard/monthList
参数：

成功返回值：

{
    status: true
    data: [{userid: "asdfasdf", card_time: "2018-9-10", card_status: 1}]
}

失败返回值：

{
    status: false,
    data: '操作失败，请重试！'
}

当月指定用户的签到信息

请求方式： POST
接口：/punchcard/userMonthList
参数：

{
    userid: '[email protected]'
}

成功返回值：

{
    status: true,
    data: [{userid: "asdfasdf", card_time: "2018-9-10", card_status: 1}]
}

失败返回值：

{
    status: false,
    data: '操作失败，请重试！'
}

获取某个level的成员

请求方式：POST
接口：/punchcard/getLevelMember
参数： 1 表示实习生 2 表示监督人员 0 普通员工

{
    id: '1'
}

成功返回值：

{
    "status":true,
    "data":[{"email":"[email protected]","name":"曲萧疏","sex":"male","remark":"无","groupId":37,"role":"user","level":2,"collector":1}]
}

失败返回值：

{
        status: false,
        data: '查询失败，请重试！'
}

设置某个人的level（1 表示实习生 2 表示监督人员 0 普通员工）

请求方式：POST
接口：/punchcard/setLevelMember
参数： 1 表示实习生 2 表示监督人员 0 普通员工

{
    level: "1", 
    userEmail: "[email protected]"
}

成功返回值：

{
    "status":true,
    "data":[{"email":"[email protected]","name":"曲萧疏","sex":"male","remark":"无","groupId":37,"role":"user","level":2,"collector":1}]
}

失败返回值：

{
    status: false,
    data: '更新失败，请重试！'
}

About

周报管理平台-前后端分离-服务端

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

8 watching

Forks

3 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 7

Languages