| 1 |
- define({ "api": [
{
"type": "get",
"url": "/api/attachment/delete/{md5}",
"title": "删除文件（图片）",
"description": "<p>删除文件（图片）</p>",
"group": "Attachment",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "md5",
"description": "<p>图片md5码</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"result\": true/false\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 205 ATTACHMENT_DELETE_FAILED 删除附件文件失败\n 206 ATTACHMENT_RECORD_DELETE_FAILED 删除附件记录失败\n 1203 ATTACHMENT_NOT_EXIST 附件不存在",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AttachmentController.php",
"groupTitle": "Attachment",
"name": "GetApiAttachmentDeleteMd5"
},
{
"type": "get",
"url": "/api/attachment/download/{md5}",
"title": "下载文件（图片）",
"description": "<p>下载文件（图片）(get code)</p>",
"group": "Attachment",
"permission": [
{
"name": "none"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "md5",
"description": "<p>图片md5码</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n 文件二进制码\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 404 Not found",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AttachmentController.php",
"groupTitle": "Attachment",
"name": "GetApiAttachmentDownloadMd5"
},
{
"type": "post",
"url": "/api/attachment/upload",
"title": "通用上传接口",
"description": "<p>通用上传接口</p>",
"group": "Attachment",
"permission": [
{
"name": "none"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "tag",
"description": "<p>附件标签</p>"
},
{
"group": "Parameter",
"type": "File",
"optional": false,
"field": "file",
"description": "<p>附件（可以多个，使用file.xxx，可返回多个）[默认大小2M, 类型图片]</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": [\n \"file_123\": \"http://localhost/web/attachment/f72e7dad80f597ed6621a009e82243ad\",\n \"file_456\": \"http://localhost/web/attachment/215a5f8307a015ecc35c80cb04d8590f\"\n ]\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 200 SAVE_USER_FAILED 保存用户数据失败\n 201 ATTACHMENT_MKDIR_FAILED 创建附件目录失败\n 202 ATTACHMENT_UPLOAD_INVALID 上传附件文件无效\n 203 ATTACHMENT_SAVE_FAILED 保存附件失败\n 204 ATTACHMENT_MOVE_FAILED 移动附件失败\n 205 ATTACHMENT_DELETE_FAILED 删除附件文件失败\n 206 ATTACHMENT_RECORD_DELETE_FAILED 删除附件记录失败\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确\n 1101 INCORRECT_VERIFY_CODE 输入验证码错误\n 1105 USER_DOES_NOT_EXIST 用户不存在\n 1200 ATTACHMENT_UPLOAD_FAILED 附件上传失败\n 1201 ATTACHMENT_SIZE_EXCEEDED 附件大小超过限制\n 1202 ATTACHMENT_MIME_NOT_ALLOWED 附件类型不允许\n 1203 ATTACHMENT_NOT_EXIST 附件不存在",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AttachmentController.php",
"groupTitle": "Attachment",
"name": "PostApiAttachmentUpload"
},
{
"type": "get",
"url": "/api/auth/logout",
"title": "退出(logout)",
"description": "<p>退出(logout)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"result\": true/false\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1104,\n \"message\": \"退出失败\",\n \"data\": null\n}\n可能出现的错误代码：\n 1104 LOGOUT_FAILED 退出失败",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "GetApiAuthLogout"
},
{
"type": "get",
"url": "/api/my/collection",
"title": "我的收藏(collection)",
"description": "<p>我的收藏(recharge)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMyCollection"
},
{
"type": "get",
"url": "/api/my/dream",
"title": "我的梦想(dream)",
"description": "<p>我的梦想(recharge)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": {\n\"dreams\": [\n{\n\"id\": 2,\n\"dream\": \"去旅游去旅游2\",\n\"about\": \"欧冠胡234\",\n\"dream_pic\": \"aaaaa\",\n\"progress\": 0, 进度\n]\n}\n}\nHTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMyDream"
},
{
"type": "get",
"url": "/api/my/dream_about",
"title": "梦想介绍(dreamAbout)",
"description": "<p>梦想介绍(dreamAbout)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMyDream_about"
},
{
"type": "get",
"url": "/api/my/persona",
"title": "个人信息(persona)",
"description": "<p>个人信息(persona)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": {\n\"user\": {\n\"id\": 1,\n\"tel\": \"13880642880\",手机\n\"nickname\": \"\",昵称\n\"sex\": 1,性别\n\"job\": \"\", 职业\n\"emotion\": 1,情感状态\n\"address\": \"\",\n\"detail_address\": \"\",\n\"status\": 1,\n\"tall\": 1, 身高\n}\n}\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": {\n\"user\": null\n}\n}",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMyPersona"
},
{
"type": "get",
"url": "/api/my/recharge",
"title": "充值(recharge)",
"description": "<p>充值(recharge)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMyRecharge"
},
{
"type": "get",
"url": "/api/my/reply_my",
"title": "回复我的(replyMy)",
"description": "<p>回复我的(replyMy)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n\n{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": {\n\"comments_infos\": [\n{\n\"id\": 1,\n\"dream_id\": 2,\n\"user_id\": 2,\n\"level\": 2,\n\"content\": \"啊哈\", 评论内容\n\"created_at\": null, 评论时间\n\"updated_at\": null,\n\"deleted_at\": null,\n\"dream_name\": \"去旅游去旅游2\", 梦想介绍\n\"dream_pic\": \"aaaaa\", 梦想图片\n\"progress\": 0, 进度\n\"reviewer\": \"22222\", 评论者\n\"reviewer_pic\": \"22222pic\", 评论者头像\n }\n ]\n }\n }",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMyReply_my"
},
{
"type": "get",
"url": "/api/my/setting",
"title": "设置(setting)",
"description": "<p>设置(setting)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMySetting"
},
{
"type": "get",
"url": "/api/my/system_info",
"title": "系统消息(systemInfo)",
"description": "<p>系统消息(systemInfo)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": {\n\"data\": [\n{\n\"nickname\": \"\",充值人\n\"pivot\": {\n\"coin\": 0 捐赠梦想币数量\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": {\n\"data\": []\n}\n}\n}",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "GetApiMySystem_info"
},
{
"type": "post",
"url": "/api/auth/avatar",
"title": "上传头像(avatar)",
"description": "<p>上传头像(reset)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "File",
"optional": false,
"field": "avatar",
"description": "<p>头像图片</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"md5\": \"fdf8dd78eb383b8acf6d94d4752c1424\",\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 200 SAVE_USER_FAILED 保存用户数据失败\n 201 ATTACHMENT_MKDIR_FAILED 创建附件目录失败\n 202 ATTACHMENT_UPLOAD_INVALID 上传附件文件无效\n 203 ATTACHMENT_SAVE_FAILED 保存附件失败\n 204 ATTACHMENT_MOVE_FAILED 移动附件失败\n 205 ATTACHMENT_DELETE_FAILED 删除附件文件失败\n 206 ATTACHMENT_RECORD_DELETE_FAILED 删除附件记录失败\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确\n 1101 INCORRECT_VERIFY_CODE 输入验证码错误\n 1105 USER_DOES_NOT_EXIST 用户不存在\n 1200 ATTACHMENT_UPLOAD_FAILED 附件上传失败\n 1201 ATTACHMENT_SIZE_EXCEEDED 附件大小超过限制\n 1202 ATTACHMENT_MIME_NOT_ALLOWED 附件类型不允许\n 1203 ATTACHMENT_NOT_EXIST 附件不存在",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthAvatar"
},
{
"type": "post",
"url": "/api/auth/bank_card/create",
"title": "添加银行卡",
"description": "<p>添加银行卡</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_name",
"description": "<p>银行名称</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_number",
"description": "<p>银行卡号</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_phone",
"description": "<p>银行预留手机号</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_user",
"description": "<p>银行卡用户姓名</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n ....\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n 可能出现的错误代码：\n 2003 BANK_CARD_ADD_FAILED 添加银行卡失败",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthBank_cardCreate"
},
{
"type": "post",
"url": "/api/auth/bank_card/delete/{id}",
"title": "删除银行卡",
"description": "<p>删除银行卡</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"success\",\n \"data\": {\n ....\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 2008,\n \"message\": \"删除银行卡失败\",\n \"data\": null or []\n}\n2001 没有此银行卡",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthBank_cardDeleteId"
},
{
"type": "post",
"url": "/api/auth/bank_card/edit",
"title": "修改银行卡",
"description": "<p>修改银行卡</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_number",
"description": "<p>银行卡号</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n ....\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 500\n{\n \"state\": false,\n \"code\": 2004,\n \"message\": \"修改银行卡失败\",\n \"data\": null or []\n}\n 可能出现的错误代码：\n 2001 BANK_CARD_NOT_EXIST 银行卡不存在",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthBank_cardEdit"
},
{
"type": "post",
"url": "/api/auth/bank_card/index",
"title": "获取银行卡列表",
"description": "<p>获取银行卡信息</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": [\n {\n \"id\": 1,\n \"user_id\": 27,\n \"bank_name\": \"测试银行\",\n \"bank_number\": \"12345678987654321\",\n \"bank_phone\": \"12345678987\"\n }\n ]\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 500\n{\n \"state\": false,\n \"code\": 2002,\n \"message\": \"获取银行卡列表失败\",\n \"data\": null or []\n}",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthBank_cardIndex"
},
{
"type": "post",
"url": "/api/auth/bank_card/update",
"title": "更新银行卡",
"description": "<p>更新银行卡</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "int",
"optional": false,
"field": "id",
"description": "<p>银行卡id</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_name",
"description": "<p>银行名称</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_number",
"description": "<p>银行卡号</p>"
},
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "bank_phone",
"description": "<p>银行预留手机号</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"success\",\n \"data\": {\n ....\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n 可能出现的错误代码：\n 2001 BANK_CARD_NOT_EXIST 银行卡不存在\n 2005 BANK_CARD_UPDATE_FAILED 更新银行卡失败",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthBank_cardUpdate"
},
{
"type": "post",
"url": "/api/auth/code",
"title": "获取验证码(get code)",
"description": "<p>获取验证码(get code)，验证码有效期暂定为15分钟</p>",
"group": "Auth",
"permission": [
{
"name": "none"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "phone",
"description": "<p>手机</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"verify_code\": \"1234\"//该值调试时使用，sms调通后取消\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthCode"
},
{
"type": "post",
"url": "/api/auth/login",
"title": "登陆（login）",
"description": "<p>登陆(login)</p>",
"group": "Auth",
"permission": [
{
"name": "none"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "phone",
"description": "<p>手机号码</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjdjYWUyYzFmYTUwMTIyZDI0ZTRiYTZhZGZhNmQxYmZlOWNiMzIxMTBmYWJlZjNjYzIyNmViZjRmNGExNWM3NjllNmU2ZTNiYWE5OGNhOWUzIn0.eyJhdWQiOiIxIiwianRpIjoiN2NhZTJjMWZhNTAxMjJkMjRlNGJhNmFkZmE2ZDFiZmU5Y2IzMjExMGZhYmVmM2NjMjI2ZWJmNGY0YTE1Yzc2OWU2ZTZlM2JhYTk4Y2E5ZTMiLCJpYXQiOjE0NzU0MTE1NTgsIm5iZiI6MTQ3NTQxMTU1OCwiZXhwIjo0NjMxMDg1MTU4LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.E9YGEzuRUOk02aV1EiWLJ_pD0hKoCyW0k_sGy63hM3u5X8K_HI1kVhaU6JNLqLZeszIAroTEDB8XMgZKAqTLlwtL8PLCJcuDoxfk1BRHbfjhDheTsahBysKGalvNEpzRCrGlao0mS0Cg9qDpEsndtypPFS8sfaflToOzbJjiSK2DvQiHSH8xZI3zHJTezgZMz-pB_hPTxp8ajdv0ve1gWtWjs3vERr0Y91X4hngO8X7LuXtAYtfxGZRIye12YE7TuLBMYzj8CCfiRt7Smhyf4palNW5mzKlZpa2l87n6NQ14Iy4oMzQ2PON1j_swrosuE2yZohGOn6fDdSCBRdJ6dLD_emjBdQCQOoB63R7BbhFZgvFX25TjzFJ7r9AdVMiGmebuRKEVSZV_JCGu1C71OIbQk-UK35s00gSr2fmJGBbN2cZTXBRTJpfuMZ_ihFYEZrvVq_Ih2X0xkd36JUuxaUld1BXRgPZvH-9jBuhe0YW2OOlgwpdm6ZB8BMcuS4ftLoi6FipgzFqfIuy-0ZqPMDnJaG7Gycrdpxza00mgOFxYxJtqwZNsUWFRZEVU881l6VC_cy294YXSPQxUwEoyKg-G5Pm8AEB9bqv5z4EU4B8-XTd3zKNqtNba_snHbc711i4EytCiZfYSjNB1hwenq45YYOAhPTwOpFI0kxyRazc\",\n \"user\": {\n \"id\": 1,\n \"name\": \"15888888888\",\n \"email\": \"abcdefg@gmail.com\",\n \"type\": 2,\n \"phone\": \"15888888888\",\n \"avatar\": null,\n \"last_ip\": null,\n \"created_at\": \"2016-09-30 00:45:13\",\n \"updated_at\": \"2016-09-29 16:43:36\"\n }\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确\n 1103 VERIFY_CODE_TOO_MUCH 验证码大于5次\n 1610 SERVICE_CODE_FAILED 验证码错误",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthLogin"
},
{
"type": "post",
"url": "/api/auth/password",
"title": "设置密码(password)",
"description": "<p>上传头像(password)</p>",
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>密码</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"result\": true,\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 200 SAVE_USER_FAILED 保存用户数据失败\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthPassword"
},
{
"type": "post",
"url": "/api/auth/register",
"title": "注册(register)",
"description": "<p>注册(register)</p>",
"group": "Auth",
"permission": [
{
"name": "none"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "phone",
"description": "<p>手机号码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "verify_code",
"description": "<p>手机验证码</p>"
},
{
"group": "Parameter",
"type": "int",
"optional": false,
"field": "type",
"description": "<p>帐户类型：1.个人，2.商户</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "name",
"defaultValue": "手机号码",
"description": "<p>用户帐号名称</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "email",
"description": "<p>邮件地址</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": true,
"field": "password",
"defaultValue": "123456",
"description": "<p>密码</p>"
},
{
"group": "Parameter",
"type": "File",
"optional": true,
"field": "avatar",
"description": "<p>用户头像</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjdjYWUyYzFmYTUwMTIyZDI0ZTRiYTZhZGZhNmQxYmZlOWNiMzIxMTBmYWJlZjNjYzIyNmViZjRmNGExNWM3NjllNmU2ZTNiYWE5OGNhOWUzIn0.eyJhdWQiOiIxIiwianRpIjoiN2NhZTJjMWZhNTAxMjJkMjRlNGJhNmFkZmE2ZDFiZmU5Y2IzMjExMGZhYmVmM2NjMjI2ZWJmNGY0YTE1Yzc2OWU2ZTZlM2JhYTk4Y2E5ZTMiLCJpYXQiOjE0NzU0MTE1NTgsIm5iZiI6MTQ3NTQxMTU1OCwiZXhwIjo0NjMxMDg1MTU4LCJzdWIiOiIxIiwic2NvcGVzIjpbXX0.E9YGEzuRUOk02aV1EiWLJ_pD0hKoCyW0k_sGy63hM3u5X8K_HI1kVhaU6JNLqLZeszIAroTEDB8XMgZKAqTLlwtL8PLCJcuDoxfk1BRHbfjhDheTsahBysKGalvNEpzRCrGlao0mS0Cg9qDpEsndtypPFS8sfaflToOzbJjiSK2DvQiHSH8xZI3zHJTezgZMz-pB_hPTxp8ajdv0ve1gWtWjs3vERr0Y91X4hngO8X7LuXtAYtfxGZRIye12YE7TuLBMYzj8CCfiRt7Smhyf4palNW5mzKlZpa2l87n6NQ14Iy4oMzQ2PON1j_swrosuE2yZohGOn6fDdSCBRdJ6dLD_emjBdQCQOoB63R7BbhFZgvFX25TjzFJ7r9AdVMiGmebuRKEVSZV_JCGu1C71OIbQk-UK35s00gSr2fmJGBbN2cZTXBRTJpfuMZ_ihFYEZrvVq_Ih2X0xkd36JUuxaUld1BXRgPZvH-9jBuhe0YW2OOlgwpdm6ZB8BMcuS4ftLoi6FipgzFqfIuy-0ZqPMDnJaG7Gycrdpxza00mgOFxYxJtqwZNsUWFRZEVU881l6VC_cy294YXSPQxUwEoyKg-G5Pm8AEB9bqv5z4EU4B8-XTd3zKNqtNba_snHbc711i4EytCiZfYSjNB1hwenq45YYOAhPTwOpFI0kxyRazc\",\n \"user\": {\n \"type\": \"2\",\n \"phone\": \"15881082737\",\n \"name\": \"15881082737\",\n \"updated_at\": \"2016-10-03 20:52:21\",\n \"created_at\": \"2016-10-03 20:52:21\",\n \"id\": 6\n }\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 200 SAVE_USER_FAILED 保存用户数据失败\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确\n 1101 INCORRECT_VERIFY_CODE 输入验证码错误",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthRegister"
},
{
"type": "post",
"url": "/api/auth/reset",
"title": "找回密码(reset)",
"description": "<p>找回密码(reset)</p>",
"group": "Auth",
"permission": [
{
"name": "none"
}
],
"version": "0.1.0",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "Phone",
"optional": false,
"field": "phone",
"description": "<p>手机</p>"
},
{
"group": "Parameter",
"type": "int",
"optional": false,
"field": "type",
"description": "<p>帐户类型：1.个人，2.商户</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "verify_code",
"description": "<p>手机验证码</p>"
},
{
"group": "Parameter",
"type": "String",
"optional": false,
"field": "password",
"description": "<p>password</p>"
}
]
}
},
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"result\": true,\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 200 SAVE_USER_FAILED 保存用户数据失败\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确\n 1101 INCORRECT_VERIFY_CODE 输入验证码错误\n 1105 USER_DOES_NOT_EXIST 用户不存在",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/AuthController.php",
"groupTitle": "Auth",
"name": "PostApiAuthReset"
},
{
"type": "post",
"url": "/api/my/add_dream",
"title": "发布梦想(addDream)",
"description": "<p>发布梦想(addDream)</p>",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "string",
"optional": false,
"field": "pic",
"description": "<p>梦想图片 数组</p>"
}
]
}
},
"group": "Auth",
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "PostApiMyAdd_dream"
},
{
"type": "post",
"url": "/api/my/my_reply",
"title": "我的回复(myReply)",
"description": "<p>我的回复(recharge)</p>",
"group": "Auth",
"parameter": {
"fields": {
"Parameter": [
{
"group": "Parameter",
"type": "text",
"optional": false,
"field": "content",
"description": "<p>回复内容</p>"
},
{
"group": "Parameter",
"type": "int",
"optional": false,
"field": "comment_id",
"description": "<p>评论ID</p>"
}
]
}
},
"permission": [
{
"name": "Passport"
}
],
"version": "0.1.0",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "{\n\"status\": true,\n\"status_code\": 0,\n\"message\": \"\",\n\"data\": \"\"\n}\nHTTP/1.1 200 OK",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "{\n\"status\": false,\n\"status_code\": 1000,\n\"message\": \"输入不正确\",\n\"data\": null\n}\n{\n\"status\": false,\n\"status_code\": 600,\n\"message\": \"保存用户数据失败\",\n\"data\": null\n}\nHTTP/1.1 400 Bad Request",
"type": "json"
}
]
},
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"groupTitle": "Auth",
"name": "PostApiMyMy_reply"
},
{
"type": "get",
"url": "/api/home/hot",
"title": "热门(hot)",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"verify_code\": \"1234\"//该值调试时使用，sms调通后取消\n }\n}",
"type": "json"
}
]
},
"error": {
"examples": [
{
"title": "Error-Response:",
"content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n可能出现的错误代码：\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/IndexController.php",
"group": "_Users_Mike_Vagrant_wwwroot_miaomiao_server_app_Http_Controllers_Api_V1_IndexController_php",
"groupTitle": "_Users_Mike_Vagrant_wwwroot_miaomiao_server_app_Http_Controllers_Api_V1_IndexController_php",
"name": "GetApiHomeHot"
},
{
"type": "get",
"url": "/api/my/index",
"title": "个人首页(index)",
"success": {
"examples": [
{
"title": "Success-Response:",
"content": "HTTP/1.1 200 OK\n {\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n \"my_care_num\": 4,关注\n \"my_fens_num\": 3,粉丝\n \"my_collection_num\": 2,收藏\n \"my_dream_num\": 1,发帖\n \"user\": {\n \"id\": 1,\n \"tel\": \"13880642880\",\n \"password\": \"\",\n \"nickname\": \"\",\n \"pic\": \"\",\n \"sign\": 0,\n \"money\": 0,余额\n \"sex\": 1,\n \"signture\": \"\",个性签名\n \"tall\": \"\",\n \"job\": \"\",\n \"emotion\": 1,\n \"address\": \"\",\n \"detail_address\": \"\",\n \"status\": 1,\n \"remember_token\": \"\",\n \"created_at\": \"2017-06-02 02:30:12\",\n \"updated_at\": \"2017-06-02 02:30:12\",\n \"deleted_at\": null,\n }",
"type": "json"
}
]
},
"version": "0.0.0",
"filename": "app/Http/Controllers/Api/V1/MyController.php",
"group": "_Users_Mike_Vagrant_wwwroot_miaomiao_server_app_Http_Controllers_Api_V1_MyController_php",
"groupTitle": "_Users_Mike_Vagrant_wwwroot_miaomiao_server_app_Http_Controllers_Api_V1_MyController_php",
"name": "GetApiMyIndex"
}
] });
|
