先後端接口文檔規範模板

[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": "新密碼",
}