horse-generator
Version:
horse generator for node framework
2 lines (1 loc) • 49.1 kB
JavaScript
define({ "api": [
{
"type": "post",
"url": "auth/local",
"title": "登录获取用户token",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/auth/local"
}
],
"group": "auth",
"name": "local",
"permission": [
{
"name": "none"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>邮箱</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>密码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "captcha",
"description": "<p>验证码</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/auth/index.js",
"groupTitle": "auth",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "commons/sendEmail",
"title": "发送邮件",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/commons/sendEmail"
}
],
"group": "commons",
"name": "sendEmail",
"permission": [
{
"name": "user"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "to",
"description": "<p>收件人邮箱</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "subject",
"description": "<p>标题</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "content",
"description": "<p>内容</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/common/sends.js",
"groupTitle": "commons",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "commons/sendMessage",
"title": "发送短信",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/commons/sendMessage"
}
],
"group": "commons",
"name": "sendMessage",
"permission": [
{
"name": "user"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "phone",
"description": "<p>手机号码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "content",
"description": "<p>内容</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/common/sends.js",
"groupTitle": "commons",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "commons/uploadFileLocal",
"title": "上传文件到本地",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/commons/uploadFileLocal"
}
],
"group": "commons",
"name": "uploadFileLocal",
"permission": [
{
"name": "user"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Binnary",
"optional": false,
"field": "file",
"description": "<p>待上传文件的路径</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/common/common.js",
"groupTitle": "commons",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "commons/uploadFileOss",
"title": "上传文件到OSS",
"description": "<p>作者：samy</p>",
"group": "commons",
"name": "uploadFileOss",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/commons/uploadFileOss"
}
],
"permission": [
{
"name": "user"
}
],
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "key",
"description": "<p>待上传文件的唯一标识</p>"
},
{
"group": "Parameter",
"type": "Binnary",
"optional": false,
"field": "file",
"description": "<p>待上传文件的路径</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/common/oss.js",
"groupTitle": "commons",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "logs/",
"title": "获取列表",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/logs/"
}
],
"group": "logs",
"name": "getList",
"permission": [
{
"name": "admin"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/log/log.js",
"groupTitle": "logs",
"parameter": {
"fields": {
"Query": [
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>指定第几页</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "10",
"description": "<p>指定每页的记录数</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "sort",
"defaultValue": "-1",
"description": "<p>是否顺倒序</p>"
},
{
"group": "Query",
"type": "String",
"optional": true,
"field": "sortBy",
"defaultValue": "updatedAt",
"description": "<p>按照排序</p>"
}
]
}
},
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "data.list",
"description": "<p>当前页列表数组</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "data.count",
"description": "<p>全部数组个数</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "partners/",
"title": "添加",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/partners/"
}
],
"group": "partners",
"name": "add",
"permission": [
{
"name": "admin"
}
],
"parameter": {
"fields": {
"Request body": [
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>经销商公司全名</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "contact",
"description": "<p>经销商负责人</p>"
},
{
"group": "Request body",
"type": "Number",
"allowedValues": [
"1",
"2",
"3"
],
"optional": false,
"field": "clazz",
"description": "<p>公司经营类型；1、线上类型；2、线下类型</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/partner/partner.js",
"groupTitle": "partners",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "delete",
"url": "partners/:id",
"title": "删除",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/partners/:id"
}
],
"group": "partners",
"name": "delOne",
"permission": [
{
"name": "admin"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/partner/partner.js",
"groupTitle": "partners",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "partners/",
"title": "获取列表及搜索",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/partners/"
}
],
"group": "partners",
"name": "getList",
"permission": [
{
"name": "user"
}
],
"parameter": {
"fields": {
"Query": [
{
"group": "Query",
"type": "String",
"optional": false,
"field": "where",
"description": "<p>查询条件(经销商负责人或经销商公司全名)</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>指定第几页</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "10",
"description": "<p>指定每页的记录数</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "sort",
"defaultValue": "-1",
"description": "<p>是否顺倒序</p>"
},
{
"group": "Query",
"type": "String",
"optional": true,
"field": "sortBy",
"defaultValue": "updatedAt",
"description": "<p>按照排序</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/partner/partner.js",
"groupTitle": "partners",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "data.list",
"description": "<p>当前页列表数组</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "data.count",
"description": "<p>全部数组个数</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "partners/:id",
"title": "获取某个",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/partners/:id"
}
],
"group": "partners",
"name": "getOne",
"permission": [
{
"name": "user"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/partner/partner.js",
"groupTitle": "partners",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "put",
"url": "partners/:id",
"title": "修改某个",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/partners/:id"
}
],
"group": "partners",
"name": "modOne",
"permission": [
{
"name": "admin"
}
],
"parameter": {
"fields": {
"Request body": [
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "name",
"description": "<p>经销商公司全名</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "contact",
"description": "<p>经销商负责人</p>"
},
{
"group": "Request body",
"type": "Number",
"optional": false,
"field": "clazz",
"description": "<p>公司经营类型；1、线上类型；2、线下类型</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/partner/partner.js",
"groupTitle": "partners",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "post",
"url": "users/",
"title": "添加",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/"
}
],
"group": "users",
"name": "add",
"permission": [
{
"name": "none"
}
],
"parameter": {
"fields": {
"Request body": [
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>邮箱</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>用户名</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>密码</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "delete",
"url": "users/:id",
"title": "删除",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/:id"
}
],
"group": "users",
"name": "delOne",
"permission": [
{
"name": "admin"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "users/getCaptcha",
"title": "获取验证码",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/getCaptcha"
}
],
"group": "users",
"name": "getCaptcha",
"permission": [
{
"name": "none"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "users/",
"title": "获取列表",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/"
}
],
"group": "users",
"name": "getList",
"permission": [
{
"name": "admin"
}
],
"parameter": {
"fields": {
"Query": [
{
"group": "Query",
"type": "String",
"optional": false,
"field": "where",
"description": "<p>查询条件(邮箱或用户名)</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "page",
"defaultValue": "1",
"description": "<p>指定第几页</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "limit",
"defaultValue": "10",
"description": "<p>指定每页的记录数</p>"
},
{
"group": "Query",
"type": "Number",
"optional": true,
"field": "sort",
"defaultValue": "-1",
"description": "<p>是否顺倒序</p>"
},
{
"group": "Query",
"type": "String",
"optional": true,
"field": "sortBy",
"defaultValue": "updatedAt",
"description": "<p>按照排序</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
},
{
"group": "Success 200",
"type": "Object[]",
"optional": false,
"field": "data.list",
"description": "<p>当前页列表数组</p>"
},
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "data.count",
"description": "<p>全部数组个数</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "users/getMe/",
"title": "获取自己",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/getMe"
}
],
"group": "users",
"name": "getMe",
"permission": [
{
"name": "none"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "users/:id",
"title": "获取某个",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/:id"
}
],
"group": "users",
"name": "getOne",
"permission": [
{
"name": "user"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "users/getSnsLogins",
"title": "获取第三方登录列表",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/getSnsLogins"
}
],
"group": "users",
"name": "getSnsLogins",
"permission": [
{
"name": "none"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "get",
"url": "users/getUserProvider",
"title": "获取自己绑定的社交账号",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/getUserProvider"
}
],
"group": "users",
"name": "getUserProvider",
"permission": [
{
"name": "user"
}
],
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "put",
"url": "users/modMe",
"title": "修改自己",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/modMe"
}
],
"group": "users",
"name": "modMe",
"permission": [
{
"name": "user"
}
],
"parameter": {
"fields": {
"Request body": [
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "email",
"description": "<p>邮箱</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "username",
"description": "<p>用户名</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
},
{
"type": "put",
"url": "users/modOne/:id",
"title": "修改某个",
"description": "<p>作者：samy</p>",
"sampleRequest": [
{
"url": "http://127.0.0.1:8787/api/users/modOne/:id"
}
],
"group": "users",
"name": "modOne",
"permission": [
{
"name": "admin"
}
],
"parameter": {
"fields": {
"Request body": [
{
"group": "Request body",
"optional": true,
"field": "role",
"defaultValue": "user",
"description": "<p>{String} role 角色,不填写默认不修改</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "partner",
"description": "<p>经销商合作伙伴,选择下拉列表，提交_id</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "status",
"description": "<p>状态,不填写默认不修改</p>"
},
{
"group": "Request body",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>密码,不填写默认不修改</p>"
}
]
}
},
"version": "0.0.0",
"filename": "src/koa/app/controller/user/user.js",
"groupTitle": "users",
"header": {
"fields": {
"": [
{
"group": "Header",
"type": "String",
"optional": false,
"field": "Authorization",
"description": "<p>jsonwebtoken</p>"
}
]
}
},
"success": {
"fields": {
"Success 200": [
{
"group": "Success 200",
"type": "Number",
"optional": false,
"field": "code",
"description": "<p>标识码，0表示成功，1表示失败</p>"
},
{
"group": "Success 200",
"type": "String",
"optional": false,
"field": "msg",
"description": "<p>标识信息</p>"
},
{
"group": "Success 200",
"type": "Object",
"optional": false,
"field": "data",
"description": "<p>数据内容</p>"
}
]
},
"examples": [
{
"title": "Response 200 Example",
"content": "HTTP/1.1 200 OK\n{\n\"code\": 0\n\"msg\": \"成功\"\n\"data\": {}\n}",
"type": "json"
},
{
"title": "Response 500 Example",
"content": "HTTP/1.1 500 Internal Server Error\n{\n\"code\": 500\n\"msg\": \"xxx\"\n}",
"type": "json"
}
]
}
}
] });