Back to top

接口规范

方便设计API的文档规范. For the rules used as a reference when building this application, see The Rules of Go

upms

这是个例子用UMPS用户模块来说明通用接口规范如何定义

upms user

用户模块

user page

user page
GET/admin/user/page{?current,size,other}

用户分页

Example URI

GET http://localhost:3000/admin/user/page?current=&size=&other=
URI Parameters
HideShow
current
number (optional) Default: 1 

当前页

size
number (optional) Default: 20 

每页几条

other
number (optional) Default: 张超 

这里是搜索参数, 如 username 用户名搜索.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 0,
  "msg": "success",
  "data": {
    "records": [
      {
        "userId": 1,
        "username": "admin",
        "password": "$2a$10$QOfWxxFyAMmEEmnuw9UI/..1s4B4eF/u9PzE2ZaGO.ij9YfmcUy.u",
        "salt": null,
        "wxOpenid": "o_0FT0uyg_H1vVy2H0JpSwlVGhWQ",
        "qqOpenid": null,
        "createTime": "2018-04-20 07:15:18",
        "updateTime": "2019-01-05 17:11:20",
        "delFlag": "0",
        "lockFlag": "0",
        "phone": "17034642888",
        "avatar": "lengleng-oxjkuoy361p6x5snlogo.png",
        "deptId": 1,
        "tenantId": 1,
        "deptName": null,
        "roleList": [
          {
            "roleId": 1,
            "roleName": "管理员",
            "roleCode": "ROLE_ADMIN",
            "roleDesc": "管理员",
            "dsType": 2,
            "dsScope": "2",
            "createTime": "2017-10-29 15:45:51",
            "updateTime": "2018-12-26 14:09:11",
            "delFlag": "0"
          }
        ]
      }
    ],
    "total": 1,
    "size": 20,
    "current": 1,
    "searchCount": true,
    "pages": 1
  }
}

create user

create user
POST/admin/user/create

用户新增.

Example URI

POST http://localhost:3000/admin/user/create
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "username": "zhangchao",
  "playerWhite": "bob",
  "playerBlack": "alfred"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 0,
  "msg": "success",
  "data": true
}

delete user

delete user
POST/admin/user/delete/{id}

用户删除

Example URI

POST http://localhost:3000/admin/user/delete/90
URI Parameters
HideShow
id
int (required) Example: 90

The id of the user.

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 0,
  "msg": "success",
  "data": true
}

update user

update user
POST/admin/user/update

用户更新

Example URI

POST http://localhost:3000/admin/user/update
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "id": 1,
  "username": "zhangchao",
  "playerWhite": "bob",
  "playerBlack": "alfred"
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "code": 0,
  "msg": "success",
  "data": true
}

Generated by aglio on 15 Feb 2019