先后端接口文档规范模板

[TOC]

xx系统接口V1

用户模块 user

POST 新增用户

• URL: /V1/user

• Request

{
  "userName":"用户名（string,50，必填）",
  "password": "密码(MD5加密，必填)",
  "account": "帐号",
  "userName": "用户帐号"
}

• Response

{
  "status": "SUCCESS",
  "result":{
  	"userId"： "用户ID"
  }
}

DELETE 删除用户

• URL: /V1/user/{userId}

• Response

{
  "status": "SUCCESS",
  "result": null
}

GET 用户列表

• URL: /V1/user

• Request

{
  "userName":"用户名（模糊查询）",
  "page": "当前页（不传查所有）",
  "size": "每页条数（不传查所有）"
}

• Response

{
  "status": "SUCCESS",
  "result": {
  	"total": "总数",
	"userList": [{
      "userName":"用户名",
      "account": "帐号",
      "userName": "用户帐号"
    }]
  }
}

GET 查询用户详情

• URL: /V1/user/{userId}

• Response

{
  "status": "SUCCESS",
  "result": {
    "userName":"用户名",
    "account": "帐号",
    "userName": "用户帐号"
  }
}

PUT 修改用户密码

• URL: /V1/user/{userId}/modifyPassword

• Request

{
  "oldPassword":"旧密码",
  "newPassword": "新密码",
}