2018年大四生产实习接口文档

六. 后端接口文档

6.1 接口文档说明

由于该项目为前后端分离项目且接口符合 RESTful API 规范，项目主要涉及的的资源实体包括员工和部门，这里列出该项目中的可用接口。

6.2 可用接口列表

• 6.2.01 获取部门/员工列表

  • 1.方法：GET
  • 2.地址：
    • /hrms/dept/getDeptName
    • /hrms/emp/getEmpList(未开发)
  • 3.返回：
    • 

      获取部门列表API
    • [图片上传失败...(image-833c03-1538127771991)]

• 6.2.02 新增部门/员工

  • 1.方法：POST
  • 2.地址：
    • /hrms/dept/addDept
    • /hrms/emp/addEmp

  • 3.返回：

• 6.2.03 删除部门/员工

  • 1.方法：DELETE
  • 2.地址：
    • /hrms/dept/deleteDept/{id}
    • /hrms/emp/deleteEmp/{id}
  • 3.返回：
    • 

      删除部门/员工API(成功)
    • 

      删除部门/员工API(失败)

• 6.2.04 更新部门/员工信息

  • 1.方法：PUT
  • 2.地址：
    • /hrms/dept/updateDept/{id}
    • /hrms/emp/updateEmp/{id}

  • 3.返回：

• 6.2.05 查询部门/员工详情

  • 1.方法：GET
  • 2.地址：
    • /hrms/dept/getDeptById/{id}
    • /hrms/emp/getEmpById/{id}
  • 3.返回：
    • 

      查询部门详情
    • 

      查询员工详情

• 6.2.06 查询部门数据总页码数

  • 1.方法：GET
  • 2.地址：/hrms/dept/getTotalPages

  • 3.返回：
    

    1EC4BE187F135A22AEEEFD8B4BDFB496.jpg

• 6.2.07 查询员工数据总页码数

  • 1.方法：GET
  • 2.地址：/hrms/emp/getTotalPages

  • 3.返回：
    

    查询员工数据总页码数API

• 6.2.08 分页部门接口

  • 1.方法：GET
  • 2.地址：/hrms/dept/getDeptList
  • 3.可选参数：pageNo=1

  • 4.返回：
    

    分页部门列表接口API

• 6.2.09 分页员工接口

  • 1.方法：GET
  • 2.地址：/hrms/emp/getEmpList
  • 3.可选参数：pageNo=1

  • 4.返回：
    

    分页员工列表接口API

• 6.2.10 登陆接口

  • 1.方法：POST
  • 2.地址：/hrms/dologin

  • 3.返回：
    

    登陆接口API

• 6.2.11 员工用户名是否重复

  • 1.方法：GET
  • 2.地址：/hrms/emp/checkEmpExists?empName=杨雪晋

  • 3.返回：
    

    员工用户名重复