Commit 619dcdc1 authored by Lanseria's avatar Lanseria

添加审核规范

parent ed3c1e58
...@@ -14,7 +14,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go) ...@@ -14,7 +14,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
用户模块 用户模块
### user page [GET /admin/user/page{?current,size,other}] ### user page [GET /upms/user/page{?current,size,other}]
用户分页 用户分页
...@@ -25,22 +25,35 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go) ...@@ -25,22 +25,35 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
+ size (number, optional) - 每页几条 + size (number, optional) - 每页几条
+ Default: `20` + Default: `20`
+ other (number, optional) - 这里是搜索参数, 如 `username` 用户名搜索. + other (number, optional) - 这里是搜索参数, 如 `username` 用户名搜索.
+ Default: `张超` + Default: `<UserName>`
+ Response 200 (application/json) + Response 200 (application/json)
{"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}} {"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}}
### create user [POST /admin/user/create] ### 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) + Request (application/json)
{ {
"username" : "zhangchao", "username" : "zhangchao",
"playerWhite" : "bob", "phone" : "17034642888",
"playerBlack" : "alfred" "roleIds" : [1, 2, 3],
} }
...@@ -48,7 +61,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go) ...@@ -48,7 +61,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
{"code":0,"msg":"success","data":true} {"code":0,"msg":"success","data":true}
### delete user [POST /admin/user/delete/{id}] ### delete user [POST /upms/user/delete/{id}]
用户删除 用户删除
...@@ -61,7 +74,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go) ...@@ -61,7 +74,7 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
{"code":0,"msg":"success","data":true} {"code":0,"msg":"success","data":true}
### update user [POST /admin/user/update] ### update user [POST /upms/user/update]
用户更新 用户更新
...@@ -70,8 +83,55 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go) ...@@ -70,8 +83,55 @@ see [The Rules of Go](https://en.wikipedia.org/wiki/Rules_of_go)
{ {
"id": 1, "id": 1,
"username" : "zhangchao", "username" : "zhangchao",
"playerWhite" : "bob", "phone" : "17034642888",
"playerBlack" : "alfred" "roleIds" : [1, 2, 3],
}
+ Response 200 (application/json)
{"code":0,"msg":"success","data":true}
# Group goms
组织模块
## goms upms
用户组织模块
### user apply [POST /goms/{uid}/apply/{oid}]
用户申请加入组织,加入组织理由可选放在`request body`
+ Parameters
+ uid: `90` (int) - 申请的用户的ID
+ oid: `90` (int) - 被申请的组织的ID
+ Request (application/json)
{
"desc" : "我申请加入的理由"
}
+ Response 200 (application/json)
{"code":0,"msg":"success","data":true}
### user apply [POST /goms/review/{uid}]
组织通过与驳回请求,驳回的理由放在`request body`
+ Parameters
+ uid: `90` (int) - 申请的用户的ID
+ Request (application/json)
{
"isPass": true // true 通过, false 驳回
"desc" : "驳回的理由"
} }
+ Response 200 (application/json) + Response 200 (application/json)
......
<!DOCTYPE html><html><head><meta charset="utf-8"><title>接口规范</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#337ab7}.action h4.action-heading .method.head{color:#fff;background-color:#337ab7}.action h4.action-heading .method.options{color:#fff;background-color:#337ab7}.action h4.action-heading .method.put{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.post{color:#fff;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#fff;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#upms">upms</a></div><div class="collapse-content"><ul><li><a href="#header-upms-user">upms user</a></li><li><a href="#upms-user-page-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>user page</a></li><li><a href="#upms-create-user-post"><span class="badge post"><i class="fa fa-plus"></i></span>create user</a></li><li><a href="#upms-delete-user-post"><span class="badge post"><i class="fa fa-plus"></i></span>delete user</a></li><li><a href="#upms-update-user-post"><span class="badge post"><i class="fa fa-plus"></i></span>update user</a></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="http://localhost:3000">http://localhost:3000</a></p></nav><div class="content"><header><h1 id="top">接口规范</h1></header><p>方便设计API的文档规范. For the rules used as a reference when building this application, <!DOCTYPE html><html><head><meta charset="utf-8"><title>接口规范</title><link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.3.0/css/font-awesome.min.css"><style>@import url('https://fonts.googleapis.com/css?family=Roboto:400,700|Inconsolata|Raleway:200');.hljs-comment,.hljs-title{color:#8e908c}.hljs-variable,.hljs-attribute,.hljs-tag,.hljs-regexp,.ruby .hljs-constant,.xml .hljs-tag .hljs-title,.xml .hljs-pi,.xml .hljs-doctype,.html .hljs-doctype,.css .hljs-id,.css .hljs-class,.css .hljs-pseudo{color:#c82829}.hljs-number,.hljs-preprocessor,.hljs-pragma,.hljs-built_in,.hljs-literal,.hljs-params,.hljs-constant{color:#f5871f}.ruby .hljs-class .hljs-title,.css .hljs-rules .hljs-attribute{color:#eab700}.hljs-string,.hljs-value,.hljs-inheritance,.hljs-header,.ruby .hljs-symbol,.xml .hljs-cdata{color:#718c00}.css .hljs-hexcolor{color:#3e999f}.hljs-function,.python .hljs-decorator,.python .hljs-title,.ruby .hljs-function .hljs-title,.ruby .hljs-title .hljs-keyword,.perl .hljs-sub,.javascript .hljs-title,.coffeescript .hljs-title{color:#4271ae}.hljs-keyword,.javascript .hljs-function{color:#8959a8}.hljs{display:block;background:white;color:#4d4d4c;padding:.5em}.coffeescript .javascript,.javascript .xml,.tex .hljs-formula,.xml .javascript,.xml .vbscript,.xml .css,.xml .hljs-cdata{opacity:.5}.right .hljs-comment{color:#969896}.right .css .hljs-class,.right .css .hljs-id,.right .css .hljs-pseudo,.right .hljs-attribute,.right .hljs-regexp,.right .hljs-tag,.right .hljs-variable,.right .html .hljs-doctype,.right .ruby .hljs-constant,.right .xml .hljs-doctype,.right .xml .hljs-pi,.right .xml .hljs-tag .hljs-title{color:#c66}.right .hljs-built_in,.right .hljs-constant,.right .hljs-literal,.right .hljs-number,.right .hljs-params,.right .hljs-pragma,.right .hljs-preprocessor{color:#de935f}.right .css .hljs-rule .hljs-attribute,.right .ruby .hljs-class .hljs-title{color:#f0c674}.right .hljs-header,.right .hljs-inheritance,.right .hljs-name,.right .hljs-string,.right .hljs-value,.right .ruby .hljs-symbol,.right .xml .hljs-cdata{color:#b5bd68}.right .css .hljs-hexcolor,.right .hljs-title{color:#8abeb7}.right .coffeescript .hljs-title,.right .hljs-function,.right .javascript .hljs-title,.right .perl .hljs-sub,.right .python .hljs-decorator,.right .python .hljs-title,.right .ruby .hljs-function .hljs-title,.right .ruby .hljs-title .hljs-keyword{color:#81a2be}.right .hljs-keyword,.right .javascript .hljs-function{color:#b294bb}.right .hljs{display:block;overflow-x:auto;background:#1d1f21;color:#c5c8c6;padding:.5em;-webkit-text-size-adjust:none}.right .coffeescript .javascript,.right .javascript .xml,.right .tex .hljs-formula,.right .xml .css,.right .xml .hljs-cdata,.right .xml .javascript,.right .xml .vbscript{opacity:.5}body{color:black;background:white;font:400 14px / 1.42 'Roboto',Helvetica,sans-serif}header{border-bottom:1px solid #f2f2f2;margin-bottom:12px}h1,h2,h3,h4,h5{color:black;margin:12px 0}h1 .permalink,h2 .permalink,h3 .permalink,h4 .permalink,h5 .permalink{margin-left:0;opacity:0;transition:opacity .25s ease}h1:hover .permalink,h2:hover .permalink,h3:hover .permalink,h4:hover .permalink,h5:hover .permalink{opacity:1}.triple h1 .permalink,.triple h2 .permalink,.triple h3 .permalink,.triple h4 .permalink,.triple h5 .permalink{opacity:.15}.triple h1:hover .permalink,.triple h2:hover .permalink,.triple h3:hover .permalink,.triple h4:hover .permalink,.triple h5:hover .permalink{opacity:.15}h1{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:36px}h2{font:200 36px 'Raleway',Helvetica,sans-serif;font-size:30px}h3{font-size:100%;text-transform:uppercase}h5{font-size:100%;font-weight:normal}p{margin:0 0 10px}p.choices{line-height:1.6}a{color:#428bca;text-decoration:none}li p{margin:0}hr.split{border:0;height:1px;width:100%;padding-left:6px;margin:12px auto;background-image:linear-gradient(to right, rgba(0,0,0,0) 20%, rgba(0,0,0,0.2) 51.4%, rgba(255,255,255,0.2) 51.4%, rgba(255,255,255,0) 80%)}dl dt{float:left;width:130px;clear:left;text-align:right;overflow:hidden;text-overflow:ellipsis;white-space:nowrap;font-weight:700}dl dd{margin-left:150px}blockquote{color:rgba(0,0,0,0.5);font-size:15.5px;padding:10px 20px;margin:12px 0;border-left:5px solid #e8e8e8}blockquote p:last-child{margin-bottom:0}pre{background-color:#f5f5f5;padding:12px;border:1px solid #cfcfcf;border-radius:6px;overflow:auto}pre code{color:black;background-color:transparent;padding:0;border:none}code{color:#444;background-color:#f5f5f5;font:'Inconsolata',monospace;padding:1px 4px;border:1px solid #cfcfcf;border-radius:3px}ul,ol{padding-left:2em}table{border-collapse:collapse;border-spacing:0;margin-bottom:12px}table tr:nth-child(2n){background-color:#fafafa}table th,table td{padding:6px 12px;border:1px solid #e6e6e6}.text-muted{opacity:.5}.note,.warning{padding:.3em 1em;margin:1em 0;border-radius:2px;font-size:90%}.note h1,.warning h1,.note h2,.warning h2,.note h3,.warning h3,.note h4,.warning h4,.note h5,.warning h5,.note h6,.warning h6{font-family:200 36px 'Raleway',Helvetica,sans-serif;font-size:135%;font-weight:500}.note p,.warning p{margin:.5em 0}.note{color:black;background-color:#f0f6fb;border-left:4px solid #428bca}.note h1,.note h2,.note h3,.note h4,.note h5,.note h6{color:#428bca}.warning{color:black;background-color:#fbf1f0;border-left:4px solid #c9302c}.warning h1,.warning h2,.warning h3,.warning h4,.warning h5,.warning h6{color:#c9302c}header{margin-top:24px}nav{position:fixed;top:24px;bottom:0;overflow-y:auto}nav .resource-group{padding:0}nav .resource-group .heading{position:relative}nav .resource-group .heading .chevron{position:absolute;top:12px;right:12px;opacity:.5}nav .resource-group .heading a{display:block;color:black;opacity:.7;border-left:2px solid transparent;margin:0}nav .resource-group .heading a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul{list-style-type:none;padding-left:0}nav ul a{display:block;font-size:13px;color:rgba(0,0,0,0.7);padding:8px 12px;border-top:1px solid #d9d9d9;border-left:2px solid transparent;overflow:hidden;text-overflow:ellipsis;white-space:nowrap}nav ul a:hover{text-decoration:none;background-color:bad-color;border-left:2px solid black}nav ul>li{margin:0}nav ul>li:first-child{margin-top:-12px}nav ul>li:last-child{margin-bottom:-12px}nav ul ul a{padding-left:24px}nav ul ul li{margin:0}nav ul ul li:first-child{margin-top:0}nav ul ul li:last-child{margin-bottom:0}nav>div>div>ul>li:first-child>a{border-top:none}.preload *{transition:none !important}.pull-left{float:left}.pull-right{float:right}.badge{display:inline-block;float:right;min-width:10px;min-height:14px;padding:3px 7px;font-size:12px;color:#000;background-color:#f2f2f2;border-radius:10px;margin:-2px 0}.badge.get{color:#70bbe1;background-color:#d9edf7}.badge.head{color:#70bbe1;background-color:#d9edf7}.badge.options{color:#70bbe1;background-color:#d9edf7}.badge.put{color:#f0db70;background-color:#fcf8e3}.badge.patch{color:#f0db70;background-color:#fcf8e3}.badge.post{color:#93cd7c;background-color:#dff0d8}.badge.delete{color:#ce8383;background-color:#f2dede}.collapse-button{float:right}.collapse-button .close{display:none;color:#428bca;cursor:pointer}.collapse-button .open{color:#428bca;cursor:pointer}.collapse-button.show .close{display:inline}.collapse-button.show .open{display:none}.collapse-content{max-height:0;overflow:hidden;transition:max-height .3s ease-in-out}nav{width:220px}.container{max-width:940px;margin-left:auto;margin-right:auto}.container .row .content{margin-left:244px;width:696px}.container .row:after{content:'';display:block;clear:both}.container-fluid nav{width:22%}.container-fluid .row .content{margin-left:24%}.container-fluid.triple nav{width:16.5%;padding-right:1px}.container-fluid.triple .row .content{position:relative;margin-left:16.5%;padding-left:24px}.middle:before,.middle:after{content:'';display:table}.middle:after{clear:both}.middle{box-sizing:border-box;width:51.5%;padding-right:12px}.right{box-sizing:border-box;float:right;width:48.5%;padding-left:12px}.right a{color:#428bca}.right h1,.right h2,.right h3,.right h4,.right h5,.right p,.right div{color:white}.right pre{background-color:#1d1f21;border:1px solid #1d1f21}.right pre code{color:#c5c8c6}.right .description{margin-top:12px}.triple .resource-heading{font-size:125%}.definition{margin-top:12px;margin-bottom:12px}.definition .method{font-weight:bold}.definition .method.get{color:#2e8ab8}.definition .method.head{color:#2e8ab8}.definition .method.options{color:#2e8ab8}.definition .method.post{color:#56b82e}.definition .method.put{color:#b8a22e}.definition .method.patch{color:#b8a22e}.definition .method.delete{color:#b82e2e}.definition .uri{word-break:break-all;word-wrap:break-word}.definition .hostname{opacity:.5}.example-names{background-color:#eee;padding:12px;border-radius:6px}.example-names .tab-button{cursor:pointer;color:black;border:1px solid #ddd;padding:6px;margin-left:12px}.example-names .tab-button.active{background-color:#d5d5d5}.right .example-names{background-color:#444}.right .example-names .tab-button{color:white;border:1px solid #666;border-radius:6px}.right .example-names .tab-button.active{background-color:#5e5e5e}#nav-background{position:fixed;left:0;top:0;bottom:0;width:16.5%;padding-right:14.4px;background-color:#fbfbfb;border-right:1px solid #f0f0f0;z-index:-1}#right-panel-background{position:absolute;right:-12px;top:-12px;bottom:-12px;width:48.6%;background-color:#333;z-index:-1}@media (max-width:1200px){nav{width:198px}.container{max-width:840px}.container .row .content{margin-left:224px;width:606px}}@media (max-width:992px){nav{width:169.4px}.container{max-width:720px}.container .row .content{margin-left:194px;width:526px}}@media (max-width:768px){nav{display:none}.container{width:95%;max-width:none}.container .row .content,.container-fluid .row .content,.container-fluid.triple .row .content{margin-left:auto;margin-right:auto;width:95%}#nav-background{display:none}#right-panel-background{width:48.6%}}.back-to-top{position:fixed;z-index:1;bottom:0;right:24px;padding:4px 8px;color:rgba(0,0,0,0.5);background-color:#f2f2f2;text-decoration:none !important;border-top:1px solid #d9d9d9;border-left:1px solid #d9d9d9;border-right:1px solid #d9d9d9;border-top-left-radius:3px;border-top-right-radius:3px}.resource-group{padding:12px;margin-bottom:12px;background-color:white;border:1px solid #d9d9d9;border-radius:6px}.resource-group h2.group-heading,.resource-group .heading a{padding:12px;margin:-12px -12px 12px -12px;background-color:#f2f2f2;border-bottom:1px solid #d9d9d9;border-top-left-radius:6px;border-top-right-radius:6px;white-space:nowrap;text-overflow:ellipsis;overflow:hidden}.triple .content .resource-group{padding:0;border:none}.triple .content .resource-group h2.group-heading,.triple .content .resource-group .heading a{margin:0 0 12px 0;border:1px solid #d9d9d9}nav .resource-group .heading a{padding:12px;margin-bottom:0}nav .resource-group .collapse-content{padding:0}.action{margin-bottom:12px;padding:12px 12px 0 12px;overflow:hidden;border:1px solid transparent;border-radius:6px}.action h4.action-heading{padding:6px 12px;margin:-12px -12px 12px -12px;border-bottom:1px solid transparent;border-top-left-radius:6px;border-top-right-radius:6px;overflow:hidden}.action h4.action-heading .name{float:right;font-weight:normal;padding:6px 0}.action h4.action-heading .method{padding:6px 12px;margin-right:12px;border-radius:3px;display:inline-block}.action h4.action-heading .method.get{color:#fff;background-color:#337ab7}.action h4.action-heading .method.head{color:#fff;background-color:#337ab7}.action h4.action-heading .method.options{color:#fff;background-color:#337ab7}.action h4.action-heading .method.put{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.patch{color:#fff;background-color:#ed9c28}.action h4.action-heading .method.post{color:#fff;background-color:#5cb85c}.action h4.action-heading .method.delete{color:#fff;background-color:#d9534f}.action h4.action-heading code{color:#444;background-color:#f5f5f5;border-color:#cfcfcf;font-weight:normal;word-break:break-all;display:inline-block;margin-top:2px}.action dl.inner{padding-bottom:2px}.action .title{border-bottom:1px solid white;margin:0 -12px -1px -12px;padding:12px}.action.get{border-color:#bce8f1}.action.get h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.head{border-color:#bce8f1}.action.head h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.options{border-color:#bce8f1}.action.options h4.action-heading{color:#337ab7;background:#d9edf7;border-bottom-color:#bce8f1}.action.post{border-color:#d6e9c6}.action.post h4.action-heading{color:#5cb85c;background:#dff0d8;border-bottom-color:#d6e9c6}.action.put{border-color:#faebcc}.action.put h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.patch{border-color:#faebcc}.action.patch h4.action-heading{color:#ed9c28;background:#fcf8e3;border-bottom-color:#faebcc}.action.delete{border-color:#ebccd1}.action.delete h4.action-heading{color:#d9534f;background:#f2dede;border-bottom-color:#ebccd1}</style></head><body class="preload"><a href="#top" class="text-muted back-to-top"><i class="fa fa-toggle-up"></i>&nbsp;Back to top</a><div class="container"><div class="row"><nav><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#upms">upms</a></div><div class="collapse-content"><ul><li><a href="#header-upms-user">upms user</a></li><li><a href="#upms-user-page-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>user page</a></li><li><a href="#upms-user-detail-get"><span class="badge get"><i class="fa fa-arrow-down"></i></span>user detail</a></li><li><a href="#upms-create-user-post"><span class="badge post"><i class="fa fa-plus"></i></span>create user</a></li><li><a href="#upms-delete-user-post"><span class="badge post"><i class="fa fa-plus"></i></span>delete user</a></li><li><a href="#upms-update-user-post"><span class="badge post"><i class="fa fa-plus"></i></span>update user</a></li></ul></div></div><div class="resource-group"><div class="heading"><div class="chevron"><i class="open fa fa-angle-down"></i></div><a href="#goms">goms</a></div><div class="collapse-content"><ul><li><a href="#header-goms-upms">goms upms</a></li><li><a href="#goms-user-apply-post"><span class="badge post"><i class="fa fa-plus"></i></span>user apply</a></li><li><a href="#goms-user-apply-post-1"><span class="badge post"><i class="fa fa-plus"></i></span>user apply</a></li></ul></div></div><p style="text-align: center; word-wrap: break-word;"><a href="http://localhost:3000">http://localhost:3000</a></p></nav><div class="content"><header><h1 id="top">接口规范</h1></header><p>方便设计API的文档规范. For the rules used as a reference when building this application,
see <a href="https://en.wikipedia.org/wiki/Rules_of_go">The Rules of Go</a></p> see <a href="https://en.wikipedia.org/wiki/Rules_of_go">The Rules of Go</a></p>
<section id="upms" class="resource-group"><h2 class="group-heading">upms <a href="#upms" class="permalink">&para;</a></h2><p>这是个例子用UMPS用户模块来说明通用接口规范如何定义</p> <section id="upms" class="resource-group"><h2 class="group-heading">upms <a href="#upms" class="permalink">&para;</a></h2><p>这是个例子用UMPS用户模块来说明通用接口规范如何定义</p>
<h2 id="header-upms-user">upms user <a class="permalink" href="#header-upms-user" aria-hidden="true"></a></h2> <h2 id="header-upms-user">upms user <a class="permalink" href="#header-upms-user" aria-hidden="true"></a></h2>
<p>用户模块</p> <p>用户模块</p>
<div id="upms-user-page" class="resource"><h3 class="resource-heading">user page <a href="#upms-user-page" class="permalink">&nbsp;&para;</a></h3><div id="upms-user-page-get" class="action get"><h4 class="action-heading"><div class="name">user page</div><a href="#upms-user-page-get" class="method get">GET</a><code class="uri">/admin/user/page{?current,size,other}</code></h4><p>用户分页</p> <div id="upms-user-page" class="resource"><h3 class="resource-heading">user page <a href="#upms-user-page" class="permalink">&nbsp;&para;</a></h3><div id="upms-user-page-get" class="action get"><h4 class="action-heading"><div class="name">user page</div><a href="#upms-user-page-get" class="method get">GET</a><code class="uri">/upms/user/page{?current,size,other}</code></h4><p>用户分页</p>
<h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/admin/user/page?<span class="hljs-attribute">current=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">size=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">other=</span><span class="hljs-literal"></span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>current</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>1</span></span>&nbsp;<p>当前页</p> <h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/upms/user/page?<span class="hljs-attribute">current=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">size=</span><span class="hljs-literal"></span>&<span class="hljs-attribute">other=</span><span class="hljs-literal"></span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>current</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>1</span></span>&nbsp;<p>当前页</p>
</dd><dt>size</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>20</span></span>&nbsp;<p>每页几条</p> </dd><dt>size</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>20</span></span>&nbsp;<p>每页几条</p>
</dd><dt>other</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>张超</span></span>&nbsp;<p>这里是搜索参数, 如 <code>username</code> 用户名搜索.</p> </dd><dt>other</dt><dd><code>number</code>&nbsp;<span>(optional)</span>&nbsp;<span class="text-info default"><strong>Default:&nbsp;</strong><span>&lt;UserName&gt;</span></span>&nbsp;<p>这里是搜索参数, 如 <code>username</code> 用户名搜索.</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, "<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>, "<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
"<span class="hljs-attribute">data</span>": <span class="hljs-value">{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{
"<span class="hljs-attribute">records</span>": <span class="hljs-value">[ "<span class="hljs-attribute">records</span>": <span class="hljs-value">[
{ {
"<span class="hljs-attribute">userId</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"admin"</span></span>, "<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"admin"</span></span>,
"<span class="hljs-attribute">password</span>": <span class="hljs-value"><span class="hljs-string">"$2a$10$QOfWxxFyAMmEEmnuw9UI/..1s4B4eF/u9PzE2ZaGO.ij9YfmcUy.u"</span></span>,
"<span class="hljs-attribute">salt</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">wxOpenid</span>": <span class="hljs-value"><span class="hljs-string">"o_0FT0uyg_H1vVy2H0JpSwlVGhWQ"</span></span>,
"<span class="hljs-attribute">qqOpenid</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">createTime</span>": <span class="hljs-value"><span class="hljs-string">"2018-04-20 07:15:18"</span></span>, "<span class="hljs-attribute">createTime</span>": <span class="hljs-value"><span class="hljs-string">"2018-04-20 07:15:18"</span></span>,
"<span class="hljs-attribute">updateTime</span>": <span class="hljs-value"><span class="hljs-string">"2019-01-05 17:11:20"</span></span>, "<span class="hljs-attribute">updateTime</span>": <span class="hljs-value"><span class="hljs-string">"2019-01-05 17:11:20"</span></span>,
"<span class="hljs-attribute">delFlag</span>": <span class="hljs-value"><span class="hljs-string">"0"</span></span>,
"<span class="hljs-attribute">lockFlag</span>": <span class="hljs-value"><span class="hljs-string">"0"</span></span>,
"<span class="hljs-attribute">phone</span>": <span class="hljs-value"><span class="hljs-string">"17034642888"</span></span>, "<span class="hljs-attribute">phone</span>": <span class="hljs-value"><span class="hljs-string">"17034642888"</span></span>,
"<span class="hljs-attribute">avatar</span>": <span class="hljs-value"><span class="hljs-string">"lengleng-oxjkuoy361p6x5snlogo.png"</span></span>,
"<span class="hljs-attribute">deptId</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">tenantId</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">deptName</span>": <span class="hljs-value"><span class="hljs-literal">null</span></span>,
"<span class="hljs-attribute">roleList</span>": <span class="hljs-value">[ "<span class="hljs-attribute">roleList</span>": <span class="hljs-value">[
{ {
"<span class="hljs-attribute">roleId</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">roleName</span>": <span class="hljs-value"><span class="hljs-string">"管理员"</span></span>, "<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"管理员"</span></span>,
"<span class="hljs-attribute">roleCode</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_ADMIN"</span></span>, "<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_ADMIN"</span></span>,
"<span class="hljs-attribute">roleDesc</span>": <span class="hljs-value"><span class="hljs-string">"管理员"</span></span>, "<span class="hljs-attribute">desc</span>": <span class="hljs-value"><span class="hljs-string">"管理员"</span></span>,
"<span class="hljs-attribute">dsType</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>, "<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">dsScope</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>, "<span class="hljs-attribute">scope</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">createTime</span>": <span class="hljs-value"><span class="hljs-string">"2017-10-29 15:45:51"</span></span>, "<span class="hljs-attribute">createTime</span>": <span class="hljs-value"><span class="hljs-string">"2017-10-29 15:45:51"</span></span>,
"<span class="hljs-attribute">updateTime</span>": <span class="hljs-value"><span class="hljs-string">"2018-12-26 14:09:11"</span></span>, "<span class="hljs-attribute">updateTime</span>": <span class="hljs-value"><span class="hljs-string">"2018-12-26 14:09:11"</span>
"<span class="hljs-attribute">delFlag</span>": <span class="hljs-value"><span class="hljs-string">"0"</span>
</span>} </span>}
] ]
</span>} </span>}
...@@ -49,32 +38,77 @@ see <a href="https://en.wikipedia.org/wiki/Rules_of_go">The Rules of Go</a></p> ...@@ -49,32 +38,77 @@ see <a href="https://en.wikipedia.org/wiki/Rules_of_go">The Rules of Go</a></p>
"<span class="hljs-attribute">searchCount</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>, "<span class="hljs-attribute">searchCount</span>": <span class="hljs-value"><span class="hljs-literal">true</span></span>,
"<span class="hljs-attribute">pages</span>": <span class="hljs-value"><span class="hljs-number">1</span> "<span class="hljs-attribute">pages</span>": <span class="hljs-value"><span class="hljs-number">1</span>
</span>} </span>}
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-create-user" class="resource"><h3 class="resource-heading">create user <a href="#upms-create-user" class="permalink">&nbsp;&para;</a></h3><div id="upms-create-user-post" class="action post"><h4 class="action-heading"><div class="name">create user</div><a href="#upms-create-user-post" class="method post">POST</a><code class="uri">/admin/user/create</code></h4><p>用户新增.</p> </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-user-detail" class="resource"><h3 class="resource-heading">user detail <a href="#upms-user-detail" class="permalink">&nbsp;&para;</a></h3><div id="upms-user-detail-get" class="action get"><h4 class="action-heading"><div class="name">user detail</div><a href="#upms-user-detail-get" class="method get">GET</a><code class="uri">/upms/user/{id}</code></h4><p>用户详情</p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/admin/user/create</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ <h4>Example URI</h4><div class="definition"><span class="method get">GET</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/upms/user/<span class="hljs-attribute" title="id">90</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>int</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>90</span></span><p>用户ID</p>
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"zhangchao"</span></span>, </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">playerWhite</span>": <span class="hljs-value"><span class="hljs-string">"bob"</span></span>, "<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">playerBlack</span>": <span class="hljs-value"><span class="hljs-string">"alfred"</span> "<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ "<span class="hljs-attribute">data</span>": <span class="hljs-value">{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"admin"</span></span>,
"<span class="hljs-attribute">createTime</span>": <span class="hljs-value"><span class="hljs-string">"2018-04-20 07:15:18"</span></span>,
"<span class="hljs-attribute">updateTime</span>": <span class="hljs-value"><span class="hljs-string">"2019-01-05 17:11:20"</span></span>,
"<span class="hljs-attribute">phone</span>": <span class="hljs-value"><span class="hljs-string">"17034642888"</span></span>,
"<span class="hljs-attribute">roleList</span>": <span class="hljs-value">[
{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">name</span>": <span class="hljs-value"><span class="hljs-string">"管理员"</span></span>,
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-string">"ROLE_ADMIN"</span></span>,
"<span class="hljs-attribute">desc</span>": <span class="hljs-value"><span class="hljs-string">"管理员"</span></span>,
"<span class="hljs-attribute">type</span>": <span class="hljs-value"><span class="hljs-number">2</span></span>,
"<span class="hljs-attribute">scope</span>": <span class="hljs-value"><span class="hljs-string">"2"</span></span>,
"<span class="hljs-attribute">createTime</span>": <span class="hljs-value"><span class="hljs-string">"2017-10-29 15:45:51"</span></span>,
"<span class="hljs-attribute">updateTime</span>": <span class="hljs-value"><span class="hljs-string">"2018-12-26 14:09:11"</span>
</span>}
]
</span>}
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-create-user" class="resource"><h3 class="resource-heading">create user <a href="#upms-create-user" class="permalink">&nbsp;&para;</a></h3><div id="upms-create-user-post" class="action post"><h4 class="action-heading"><div class="name">create user</div><a href="#upms-create-user-post" class="method post">POST</a><code class="uri">/upms/user/create</code></h4><p>用户新增</p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/upms/user/create</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">username</span>" : <span class="hljs-value"><span class="hljs-string">"zhangchao"</span></span>,
"<span class="hljs-attribute">phone</span>" : <span class="hljs-value"><span class="hljs-string">"17034642888"</span></span>,
"<span class="hljs-attribute">roleIds</span>" : <span class="hljs-value">[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]</span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, "<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>, "<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
"<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span> "<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-delete-user" class="resource"><h3 class="resource-heading">delete user <a href="#upms-delete-user" class="permalink">&nbsp;&para;</a></h3><div id="upms-delete-user-post" class="action post"><h4 class="action-heading"><div class="name">delete user</div><a href="#upms-delete-user-post" class="method post">POST</a><code class="uri">/admin/user/delete/{id}</code></h4><p>用户删除</p> </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-delete-user" class="resource"><h3 class="resource-heading">delete user <a href="#upms-delete-user" class="permalink">&nbsp;&para;</a></h3><div id="upms-delete-user-post" class="action post"><h4 class="action-heading"><div class="name">delete user</div><a href="#upms-delete-user-post" class="method post">POST</a><code class="uri">/upms/user/delete/{id}</code></h4><p>用户删除</p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/admin/user/delete/<span class="hljs-attribute" title="id">90</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>int</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>90</span></span><p>The id of the user.</p> <h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/upms/user/delete/<span class="hljs-attribute" title="id">90</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>id</dt><dd><code>int</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>90</span></span><p>The id of the user.</p>
</dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ </dd></dl></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, "<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>, "<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
"<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span> "<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-update-user" class="resource"><h3 class="resource-heading">update user <a href="#upms-update-user" class="permalink">&nbsp;&para;</a></h3><div id="upms-update-user-post" class="action post"><h4 class="action-heading"><div class="name">update user</div><a href="#upms-update-user-post" class="method post">POST</a><code class="uri">/admin/user/update</code></h4><p>用户更新</p> </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="upms-update-user" class="resource"><h3 class="resource-heading">update user <a href="#upms-update-user" class="permalink">&nbsp;&para;</a></h3><div id="upms-update-user-post" class="action post"><h4 class="action-heading"><div class="name">update user</div><a href="#upms-update-user-post" class="method post">POST</a><code class="uri">/upms/user/update</code></h4><p>用户更新</p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/admin/user/update</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ <h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/upms/user/update</span></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>, "<span class="hljs-attribute">id</span>": <span class="hljs-value"><span class="hljs-number">1</span></span>,
"<span class="hljs-attribute">username</span>": <span class="hljs-value"><span class="hljs-string">"zhangchao"</span></span>, "<span class="hljs-attribute">username</span>" : <span class="hljs-value"><span class="hljs-string">"zhangchao"</span></span>,
"<span class="hljs-attribute">playerWhite</span>": <span class="hljs-value"><span class="hljs-string">"bob"</span></span>, "<span class="hljs-attribute">phone</span>" : <span class="hljs-value"><span class="hljs-string">"17034642888"</span></span>,
"<span class="hljs-attribute">playerBlack</span>": <span class="hljs-value"><span class="hljs-string">"alfred"</span> "<span class="hljs-attribute">roleIds</span>" : <span class="hljs-value">[<span class="hljs-number">1</span>, <span class="hljs-number">2</span>, <span class="hljs-number">3</span>]</span>,
}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
"<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section><section id="goms" class="resource-group"><h2 class="group-heading">goms <a href="#goms" class="permalink">&para;</a></h2><p>组织模块</p>
<h2 id="header-goms-upms">goms upms <a class="permalink" href="#header-goms-upms" aria-hidden="true"></a></h2>
<p>用户组织模块</p>
<div id="goms-user-apply" class="resource"><h3 class="resource-heading">user apply <a href="#goms-user-apply" class="permalink">&nbsp;&para;</a></h3><div id="goms-user-apply-post" class="action post"><h4 class="action-heading"><div class="name">user apply</div><a href="#goms-user-apply-post" class="method post">POST</a><code class="uri">/goms/{uid}/apply/{oid}</code></h4><p>用户申请加入组织,加入组织理由可选放在<code>request body</code></p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/goms/<span class="hljs-attribute" title="uid">90</span>/apply/<span class="hljs-attribute" title="oid">90</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>uid</dt><dd><code>int</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>90</span></span><p>申请的用户的ID</p>
</dd><dt>oid</dt><dd><code>int</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>90</span></span><p>被申请的组织的ID</p>
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">desc</span>": <span class="hljs-value"><span class="hljs-string">"我申请加入的理由"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
"<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div><div id="goms-user-apply-1" class="resource"><h3 class="resource-heading">user apply <a href="#goms-user-apply-1" class="permalink">&nbsp;&para;</a></h3><div id="goms-user-apply-post-1" class="action post"><h4 class="action-heading"><div class="name">user apply</div><a href="#goms-user-apply-post-1" class="method post">POST</a><code class="uri">/goms/review/{uid}</code></h4><p>组织通过与驳回请求,驳回的理由放在<code>request body</code></p>
<h4>Example URI</h4><div class="definition"><span class="method post">POST</span>&nbsp;<span class="uri"><span class="hostname">http://localhost:3000</span>/goms/review/<span class="hljs-attribute" title="uid">90</span></span></div><div class="title"><strong>URI Parameters</strong><div class="collapse-button show"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><dl class="inner"><dt>uid</dt><dd><code>int</code>&nbsp;<span class="required">(required)</span>&nbsp;<span class="text-muted example"><strong>Example:&nbsp;</strong><span>90</span></span><p>申请的用户的ID</p>
</dd></dl></div><div class="title"><strong>Request</strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">isPass</span>": <span class="hljs-value"><span class="hljs-literal">true</span> // <span class="hljs-literal">true</span> 通过, <span class="hljs-literal">false</span> 驳回
<span class="hljs-string">"desc"</span> : <span class="hljs-string">"驳回的理由"</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{ </span>}</code></pre><div style="height: 1px;"></div></div></div><div class="title"><strong>Response&nbsp;&nbsp;<code>200</code></strong><div class="collapse-button"><span class="close">Hide</span><span class="open">Show</span></div></div><div class="collapse-content"><div class="inner"><h5>Headers</h5><pre><code><span class="hljs-attribute">Content-Type</span>: <span class="hljs-string">application/json</span></code></pre><div style="height: 1px;"></div><h5>Body</h5><pre><code>{
"<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>, "<span class="hljs-attribute">code</span>": <span class="hljs-value"><span class="hljs-number">0</span></span>,
"<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>, "<span class="hljs-attribute">msg</span>": <span class="hljs-value"><span class="hljs-string">"success"</span></span>,
"<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span> "<span class="hljs-attribute">data</span>": <span class="hljs-value"><span class="hljs-literal">true</span>
</span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 15 Feb 2019</p><script>/* eslint-env browser */ </span>}</code></pre><div style="height: 1px;"></div></div></div></div></div></section></div></div></div><p style="text-align: center;" class="text-muted">Generated by&nbsp;<a href="https://github.com/danielgtaylor/aglio" class="aglio">aglio</a>&nbsp;on 28 Feb 2019</p><script>/* eslint-env browser */
/* eslint quotes: [2, "single"] */ /* eslint quotes: [2, "single"] */
'use strict'; 'use strict';
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment