index.apib

FORMAT: 1A
HOST: http://localhost:3000

# 接口规范

方便设计API的文档规范. For the rules used as a reference when building this application,
see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)

# Group upms

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

## upms user

用户模块

### user page [GET /upms/user/page{?current,size,other}]

用户分页

+ Parameters

    + current (number, optional) - 当前页
        + Default: `1`
    + size (number, optional) - 每页几条
        + Default: `20`
    + other (number, optional) - 这里是搜索参数, 如 `username` 用户名搜索.
        + Default: `<UserName>`

+ Response 200 (application/json)

        {"code":0,"msg":"success","data":{"records":[{"id":1,"username":"admin","createTime":"2018-04-20 07:15:18","updateTime":"2019-01-05 17:11:20","phone":"17034642888","roleList":[{"id":1,"name":"管理员","code":"ROLE_ADMIN","desc":"管理员","type":2,"scope":"2","createTime":"2017-10-29 15:45:51","updateTime":"2018-12-26 14:09:11"}]}],"total":1,"size":20,"current":1,"searchCount":true,"pages":1}}

### user detail [GET /upms/user/{id}]

用户详情


+ Parameters

    + id: `90` (int) - 用户ID

+ Response 200 (application/json)

        {"code":0,"msg":"success", "data":{"id":1,"username":"admin","createTime":"2018-04-20 07:15:18","updateTime":"2019-01-05 17:11:20","phone":"17034642888","roleList":[{"id":1,"name":"管理员","code":"ROLE_ADMIN","desc":"管理员","type":2,"scope":"2","createTime":"2017-10-29 15:45:51","updateTime":"2018-12-26 14:09:11"}]}}

### create user  [POST /upms/user/create]

用户新增

+ Request (application/json)

        {
            "username" : "zhangchao",
            "phone" : "17034642888",
            "roleIds" : [1, 2, 3],
        }


+ Response 200 (application/json)

        {"code":0,"msg":"success","data":true}

### update user [POST /upms/user/update]

用户更新

+ Request (application/json)

        {
            "id": 1,
            "username" : "zhangchao",
            "phone" : "17034642888",
            "roleIds" : [1, 2, 3],
        }

+ Response 200 (application/json)

        {"code":0,"msg":"success","data":true}

### delete user batch [POST /upms/user/delete/batch]

用户删除(批量与单个同存)

+ Request (application/json)

        [1, 2, 3, 4]

+ Response 200 (application/json)

        {"code":0,"msg":"success","data":true}

# Group goms

组织模块

## goms upms

用户组织模块

### user apply [POST /goms/apply]

用户申请加入组织，加入组织理由可选放在`request body`里

+ Request (application/json)

        {
            "uid": 1,
            "oid": 2,
            "content" : "我申请加入的理由"
        }

+ Response 200 (application/json)

        {"code":0,"msg":"success","data":true}

### user pass batch [POST /goms/review/batch]

组织通过(批量与单个同存)，可选通过的理由放在`request body`里

+ Request (application/json)

        {
            "ids": [1, 2, 3],
            "status": 3, // 用来变更状态
            "content" : "通过的理由"
        }

+ Response 200 (application/json)

        {"code":0,"msg":"success","data":true}