api_data.js 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840
  1. define({ "api": [
  2. {
  3. "type": "get",
  4. "url": "/api/attachment/delete/{md5}",
  5. "title": "删除文件(图片)",
  6. "description": "<p>删除文件(图片)</p>",
  7. "group": "Attachment",
  8. "permission": [
  9. {
  10. "name": "Passport"
  11. }
  12. ],
  13. "version": "0.1.0",
  14. "parameter": {
  15. "fields": {
  16. "Parameter": [
  17. {
  18. "group": "Parameter",
  19. "type": "string",
  20. "optional": false,
  21. "field": "md5",
  22. "description": "<p>图片md5码</p>"
  23. }
  24. ]
  25. }
  26. },
  27. "success": {
  28. "examples": [
  29. {
  30. "title": "Success-Response:",
  31. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"result\": true/false\n }\n}",
  32. "type": "json"
  33. }
  34. ]
  35. },
  36. "error": {
  37. "examples": [
  38. {
  39. "title": "Error-Response:",
  40. "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 附件不存在",
  41. "type": "json"
  42. }
  43. ]
  44. },
  45. "filename": "app/Http/Controllers/Api/V1/AttachmentController.php",
  46. "groupTitle": "Attachment",
  47. "name": "GetApiAttachmentDeleteMd5"
  48. },
  49. {
  50. "type": "get",
  51. "url": "/api/attachment/download/{md5}",
  52. "title": "下载文件(图片)",
  53. "description": "<p>下载文件(图片)(get code)</p>",
  54. "group": "Attachment",
  55. "permission": [
  56. {
  57. "name": "none"
  58. }
  59. ],
  60. "version": "0.1.0",
  61. "parameter": {
  62. "fields": {
  63. "Parameter": [
  64. {
  65. "group": "Parameter",
  66. "type": "string",
  67. "optional": false,
  68. "field": "md5",
  69. "description": "<p>图片md5码</p>"
  70. }
  71. ]
  72. }
  73. },
  74. "success": {
  75. "examples": [
  76. {
  77. "title": "Success-Response:",
  78. "content": "HTTP/1.1 200 OK\n{\n 文件二进制码\n}",
  79. "type": "json"
  80. }
  81. ]
  82. },
  83. "error": {
  84. "examples": [
  85. {
  86. "title": "Error-Response:",
  87. "content": "HTTP/1.1 404 Not found",
  88. "type": "json"
  89. }
  90. ]
  91. },
  92. "filename": "app/Http/Controllers/Api/V1/AttachmentController.php",
  93. "groupTitle": "Attachment",
  94. "name": "GetApiAttachmentDownloadMd5"
  95. },
  96. {
  97. "type": "post",
  98. "url": "/api/attachment/upload",
  99. "title": "通用上传接口",
  100. "description": "<p>通用上传接口</p>",
  101. "group": "Attachment",
  102. "permission": [
  103. {
  104. "name": "none"
  105. }
  106. ],
  107. "version": "0.1.0",
  108. "parameter": {
  109. "fields": {
  110. "Parameter": [
  111. {
  112. "group": "Parameter",
  113. "type": "string",
  114. "optional": false,
  115. "field": "tag",
  116. "description": "<p>附件标签 avatar video dream</p>"
  117. },
  118. {
  119. "group": "Parameter",
  120. "type": "File",
  121. "optional": false,
  122. "field": "file",
  123. "description": "<p>附件(可以多个,使用file.xxx,可返回多个)[默认大小【10M】, 类型图片png jpg gif,视频类型mp4]</p>"
  124. }
  125. ]
  126. }
  127. },
  128. "success": {
  129. "examples": [
  130. {
  131. "title": "Success-Response:",
  132. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": [\n \"md5\": \"57c0fe723e1d7f7b0e45fd455aee19f2\",\n \"url\": \"http://dev.xxg.com/upload/upload/20180727/57c0fe723e1d7f7b0e45fd455aee19f2.jpg\"\n ]\n}",
  133. "type": "json"
  134. }
  135. ]
  136. },
  137. "error": {
  138. "examples": [
  139. {
  140. "title": "Error-Response:",
  141. "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 附件不存在",
  142. "type": "json"
  143. }
  144. ]
  145. },
  146. "filename": "app/Http/Controllers/Api/V1/AttachmentController.php",
  147. "groupTitle": "Attachment",
  148. "name": "PostApiAttachmentUpload"
  149. },
  150. {
  151. "type": "get",
  152. "url": "/api/home/couponlist",
  153. "title": "可领取的优惠券列表",
  154. "description": "<p>可领取的优惠券列表</p>",
  155. "group": "Coupon",
  156. "permission": [
  157. {
  158. "name": "Passport"
  159. }
  160. ],
  161. "version": "0.1.0",
  162. "success": {
  163. "examples": [
  164. {
  165. "title": "Success-Response:",
  166. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": [\n...\n {\n \"id\": 1,\n \"name\": \"证件照七折优惠\", //优惠券名字\n \"type\": \"1\", //优惠券类型 0:固定金额优惠,1:折扣优惠\n \"min_price\": 100, //最低使用金额\n \"discount\": \"7\", //折扣\n \"discount_price\": null, //优惠金额\n \"product_id\": \"1,2\", //可使用的产品id\n \"count\": 10, //剩余数量\n \"end_time\": \"2018-07-31\", //有效期\n \"created_at\": \"2018-07-13 07:29:27\",\n \"updated_at\": \"2018-07-18 06:36:38\"e\n }\n...\n ]\n}",
  167. "type": "json"
  168. }
  169. ]
  170. },
  171. "error": {
  172. "examples": [
  173. {
  174. "title": "Error-Response:",
  175. "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 传入参数不正确",
  176. "type": "json"
  177. }
  178. ]
  179. },
  180. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  181. "groupTitle": "Coupon",
  182. "name": "GetApiHomeCouponlist"
  183. },
  184. {
  185. "type": "get",
  186. "url": "/api/home/getcoupon",
  187. "title": "领取优惠券",
  188. "description": "<p>领取优惠券</p>",
  189. "group": "Coupon",
  190. "permission": [
  191. {
  192. "name": "Passport"
  193. }
  194. ],
  195. "version": "0.1.0",
  196. "parameter": {
  197. "fields": {
  198. "Parameter": [
  199. {
  200. "group": "Parameter",
  201. "type": "int",
  202. "optional": false,
  203. "field": "coupon_id",
  204. "description": "<p>优惠券ID</p>"
  205. }
  206. ]
  207. }
  208. },
  209. "success": {
  210. "examples": [
  211. {
  212. "title": "Success-Response:",
  213. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n \"res\": true //领取成功\n }\n}",
  214. "type": "json"
  215. }
  216. ]
  217. },
  218. "error": {
  219. "examples": [
  220. {
  221. "title": "Error-Response:",
  222. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n \"code\": 10001,\n \"msg\": \"你已经领取过改优惠券,不能重复领取!\"\n }\n}\n可能出现的错误代码:\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确\n 1001 CLIENT_WRONG_PARAMS 你已经领取过改优惠券,不能重复领取",
  223. "type": "json"
  224. }
  225. ]
  226. },
  227. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  228. "groupTitle": "Coupon",
  229. "name": "GetApiHomeGetcoupon"
  230. },
  231. {
  232. "type": "get",
  233. "url": "/api/home/mycoupon",
  234. "title": "我的优惠券列表",
  235. "description": "<p>我的优惠券列表</p>",
  236. "group": "Coupon",
  237. "permission": [
  238. {
  239. "name": "Passport"
  240. }
  241. ],
  242. "version": "0.1.0",
  243. "success": {
  244. "examples": [
  245. {
  246. "title": "Success-Response:",
  247. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": [\n...\n {\n \"id\": 1,\n \"coupon_id\": 1,\n \"user_id\": 1,\n \"coupon\": {\n \"id\": 1,\n \"name\": \"证件照七折优惠\", //优惠券名字\n \"type\": \"1\", //优惠券类型 0:固定金额优惠,1:折扣优惠\n \"min_price\": 100, //最低使用金额\n \"discount\": \"7\", //折扣\n \"discount_price\": null, //优惠金额\n \"product_id\": \"1,2\", //可使用的产品id\n \"count\": 10,\n \"end_time\": \"2018-07-31\", //有效期\n \"created_at\": \"2018-07-13 07:29:27\",\n \"updated_at\": \"2018-07-18 06:36:38\"\n }\n }\n ]\n...\n}",
  248. "type": "json"
  249. }
  250. ]
  251. },
  252. "error": {
  253. "examples": [
  254. {
  255. "title": "Error-Response:",
  256. "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 传入参数不正确",
  257. "type": "json"
  258. }
  259. ]
  260. },
  261. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  262. "groupTitle": "Coupon",
  263. "name": "GetApiHomeMycoupon"
  264. },
  265. {
  266. "type": "get",
  267. "url": "/api/home/usablecoupon",
  268. "title": "获取订单可用的优惠券",
  269. "description": "<p>获取订单可用的优惠券</p>",
  270. "group": "Coupon",
  271. "permission": [
  272. {
  273. "name": "Passport"
  274. }
  275. ],
  276. "version": "0.1.0",
  277. "parameter": {
  278. "fields": {
  279. "Parameter": [
  280. {
  281. "group": "Parameter",
  282. "type": "int",
  283. "optional": false,
  284. "field": "product_id",
  285. "description": "<p>产品规格ID,订单中获取</p>"
  286. }
  287. ]
  288. }
  289. },
  290. "success": {
  291. "examples": [
  292. {
  293. "title": "Success-Response:",
  294. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\":\n...\n [\n {\n \"id\": 1,\n \"coupon_id\": 1,\n \"user_id\": 1,\n \"coupon\": {\n \"id\": 1,\n \"name\": \"证件照七折优惠\",\n \"type\": \"1\",\n \"min_price\": 100,\n \"discount\": \"7\",\n \"discount_price\": null,\n \"product_id\": \"1,2\",\n \"count\": 7,\n \"end_time\": \"2018-07-31\",\n \"created_at\": \"2018-07-13 07:29:27\",\n \"updated_at\": \"2018-07-21 07:41:59\"\n }\n }\n ]\n...\n}",
  295. "type": "json"
  296. }
  297. ]
  298. },
  299. "error": {
  300. "examples": [
  301. {
  302. "title": "Error-Response:",
  303. "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 传入参数不正确",
  304. "type": "json"
  305. }
  306. ]
  307. },
  308. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  309. "groupTitle": "Coupon",
  310. "name": "GetApiHomeUsablecoupon"
  311. },
  312. {
  313. "type": "post",
  314. "url": "/api/home/login",
  315. "title": "登陆(login)",
  316. "description": "<p>登陆(login)</p>",
  317. "group": "Login",
  318. "permission": [
  319. {
  320. "name": "none"
  321. }
  322. ],
  323. "version": "0.1.0",
  324. "parameter": {
  325. "fields": {
  326. "Parameter": [
  327. {
  328. "group": "Parameter",
  329. "type": "string",
  330. "optional": false,
  331. "field": "code",
  332. "description": "<p>小程序登陆后返回的code</p>"
  333. },
  334. {
  335. "group": "Parameter",
  336. "type": "string",
  337. "optional": false,
  338. "field": "nickName",
  339. "description": "<p>微信昵称</p>"
  340. },
  341. {
  342. "group": "Parameter",
  343. "type": "string",
  344. "optional": false,
  345. "field": "avatar",
  346. "description": "<p>微信头像</p>"
  347. }
  348. ]
  349. }
  350. },
  351. "success": {
  352. "examples": [
  353. {
  354. "title": "Success-Response:",
  355. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n\"token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6IjUzMzYwMzNlNzIwOTE3YjE0NDc4YjgxMWY5MmI4MjBmMThlNDgxNjJjZGFkYmEwNGI3ZjliZTNmZjRlMTY2YjU4NGU4MzJhN2RmYzY2ZTcxIn0.eyJhdWQiOiIxIiwianRpIjoiNTMzNjAzM2U3MjA5MTdiMTQ0NzhiODExZjkyYjgyMGYxOGU0ODE2MmNkYWRiYTA0YjdmOWJlM2ZmNGUxNjZiNTg0ZTgzMmE3ZGZjNjZlNzEiLCJpYXQiOjE1MzI0MjA3NDAsIm5iZiI6MTUzMjQyMDc0MCwiZXhwIjoxNTYzOTU2NzQwLCJzdWIiOiIyIiwic2NvcGVzIjpbXX0.YnuRiJI9jlt-KeQ480UEpLWCUU8FEJvlTRtAdjOlP0BWmcdo0E9rGS4hriYnpfJOn09Cw0aRYuc4dgQYL_JWD2fodlGg1LRIvPTOtvM5TiwM86kQJawvfFw7X7p9nOhxrFa5Tyir0cdTcV0SmQbq8KIptjdR8j7wUTByKhONexBXtNnlZSpw70ckTQrAstkn97IDwPo04hhGhf6eDPc8ler0HONiAVqbRvvNG6yHShJarP1hxyXrYN2BM0N7dtLD_8Sr8XaXL6ie4rRFVM4fNwpn74DkiDwXY6-5Xet6mzPvvzARAmU5vJ7JHhcL1N7m7poNp6YCx_mZAZ1z8PGDKrtQWoVeAmIxo7qtI6jvgvUpEFnJQ-KHCunXflNBL-vIYW4o3llnYqku1pcBdAUfkYLjYUgB3EZio280_8q-6Q24VAMiHZ58AjYvHHJJssdOa3dVHGD9Iq2z1dWR6gmZ4MgGCunCcAe9L_CbDm7VtMq3nKj4a1WScRiMD5nlKAHgy4O32rtNXqDr5T-eV-QNa4ZOv4VZ1AR-WE4RkO4ArKPaFxgSa9mak98PU8NHcPaJ_B3eDbvtwtMloTXWSQP08cmUPXKjEwXvszdkUt-ZWirw5Sd22h3qMdCI3gcvzT4_rnDKCEk37P09fUIK8LZrS4s2xOhueHziMzheAF0QekI\",\n \"user\": {\n \"id\": 2,\n \"nickname\": \"roger\",\n \"openid\": \"olAS94uwfTdsL3nDnvG67p_v5Vks\",\n \"mobile\": \"13788765546\",\n \"avatar\": \"https://wx.qlogo.cn/mmopen/vi_32/IOcxico8l4A7W3qxDeA53Id5kVAj2ibUGvQib9QibicTp5c1RNshDj6EKz2PKWp3reHfib0xxT4wa7jJzcb7a4EggkVw/132\",\n }\n }\n}",
  356. "type": "json"
  357. }
  358. ]
  359. },
  360. "error": {
  361. "examples": [
  362. {
  363. "title": "Error-Response:",
  364. "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 500 获取openid失败",
  365. "type": "json"
  366. }
  367. ]
  368. },
  369. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  370. "groupTitle": "Login",
  371. "name": "PostApiHomeLogin"
  372. },
  373. {
  374. "type": "get",
  375. "url": "/api/home/createorder",
  376. "title": "创建订单",
  377. "description": "<p>创建订单</p>",
  378. "group": "Order",
  379. "permission": [
  380. {
  381. "name": "Passport"
  382. }
  383. ],
  384. "version": "0.1.0",
  385. "parameter": {
  386. "fields": {
  387. "Parameter": [
  388. {
  389. "group": "Parameter",
  390. "type": "int",
  391. "optional": false,
  392. "field": "store_id",
  393. "description": "<p>预约店铺ID</p>"
  394. },
  395. {
  396. "group": "Parameter",
  397. "type": "int",
  398. "optional": false,
  399. "field": "product_id",
  400. "description": "<p>产品规格ID</p>"
  401. },
  402. {
  403. "group": "Parameter",
  404. "type": "string",
  405. "optional": false,
  406. "field": "schedule_time",
  407. "description": "<p>预约时间</p>"
  408. },
  409. {
  410. "group": "Parameter",
  411. "type": "string",
  412. "optional": false,
  413. "field": "username",
  414. "description": "<p>到店人姓名</p>"
  415. },
  416. {
  417. "group": "Parameter",
  418. "type": "string",
  419. "optional": false,
  420. "field": "phone",
  421. "description": "<p>联系方式</p>"
  422. },
  423. {
  424. "group": "Parameter",
  425. "type": "string",
  426. "optional": false,
  427. "field": "email",
  428. "description": "<p>邮箱(接受照片用)</p>"
  429. },
  430. {
  431. "group": "Parameter",
  432. "type": "int",
  433. "optional": false,
  434. "field": "sex",
  435. "description": "<p>性别 (0:男;1:女)</p>"
  436. },
  437. {
  438. "group": "Parameter",
  439. "type": "string",
  440. "optional": true,
  441. "field": "comment",
  442. "description": "<p>备注</p>"
  443. }
  444. ]
  445. }
  446. },
  447. "success": {
  448. "examples": [
  449. {
  450. "title": "Success-Response:",
  451. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"id\": 27,\n \"out_trade_no\": \"xxg1531993028\", //订单编号\n \"username\": \"lee\", //联系人\n \"phone\": \"13407570876\", //联系电话\n \"email\": \"154@qq.com\", //邮箱\n \"schedule_time\": \"2018-07-19 11:00:00\", //预约时间\n \"status\": 0,\n \"store_id\": \"1\",\n \"storename\": \"青羊店\", //店铺名称\n \"product_name\": \"证件照\", //产品名称\n \"service_time\": \"约120分钟\", //服务时长\n \"price\": 199, //应付金额\n \"deposit\": 100 //定金\n }\n\n}",
  452. "type": "json"
  453. }
  454. ]
  455. },
  456. "error": {
  457. "examples": [
  458. {
  459. "title": "Error-Response:",
  460. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  461. "type": "json"
  462. }
  463. ]
  464. },
  465. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  466. "groupTitle": "Order",
  467. "name": "GetApiHomeCreateorder"
  468. },
  469. {
  470. "type": "get",
  471. "url": "/api/home/myorders",
  472. "title": "我的订单列表",
  473. "description": "<p>我的订单列表</p>",
  474. "group": "Order",
  475. "permission": [
  476. {
  477. "name": "Passport"
  478. }
  479. ],
  480. "version": "0.1.0",
  481. "parameter": {
  482. "fields": {
  483. "Parameter": [
  484. {
  485. "group": "Parameter",
  486. "type": "int",
  487. "optional": true,
  488. "field": "status",
  489. "description": "<p>订单状态:1:已付款,未完成拍摄;2:拍摄完成;3:已取消</p>"
  490. }
  491. ]
  492. }
  493. },
  494. "success": {
  495. "examples": [
  496. {
  497. "title": "Success-Response:",
  498. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"current_page\": 1, //当前页\n \"data\": [\n ...\n {\n \"id\": 3,\n \"out_trade_no\": \"s10003\", //订单编号\n \"username\": \"roger\",\n \"sex\": 0,\n \"phone\": \"13407570876\",\n \"email\": \"154@qq.com\",\n \"store_id\": \"1\",\n \"schedule_time\": \"2018-07-19 10:00:00\", //预约时间\n \"status\": 2,\n \"user_id\": 1,\n \"product_id\": 1,\n \"schedule_id\": null,\n \"comment\": \"\",\n \"created_at\": \"2018-07-19 08:53:02\",\n \"updated_at\": \"2018-07-19 08:53:02\",\n \"price\": null,\n \"deposit\": null,\n \"storename\": \"青羊店\",\n \"product_name\": \"证件照\"\n },\n ...\n ],\n \"first_page_url\": \"http://dev.xxg.com/api/home/myorders?page=1\", //首页地址\n \"from\": 1,\n \"last_page\": 2,\n \"last_page_url\": \"http://dev.xxg.com/api/home/myorders?page=2\", //最后一页地址\n \"next_page_url\": \"http://dev.xxg.com/api/home/myorders?page=2\", //下一页地址\n \"path\": \"http://dev.xxg.com/api/home/myorders\",\n \"per_page\": 5, //每页显示数量\n \"prev_page_url\": null, //上一页地址\n \"to\": 5,\n \"total\": 7\n }\n}",
  499. "type": "json"
  500. }
  501. ]
  502. },
  503. "error": {
  504. "examples": [
  505. {
  506. "title": "Error-Response:",
  507. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  508. "type": "json"
  509. }
  510. ]
  511. },
  512. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  513. "groupTitle": "Order",
  514. "name": "GetApiHomeMyorders"
  515. },
  516. {
  517. "type": "get",
  518. "url": "/api/home/order",
  519. "title": "获取订单详情",
  520. "description": "<p>获取订单详情</p>",
  521. "group": "Order",
  522. "permission": [
  523. {
  524. "name": "None"
  525. }
  526. ],
  527. "version": "0.1.0",
  528. "parameter": {
  529. "fields": {
  530. "Parameter": [
  531. {
  532. "group": "Parameter",
  533. "type": "int",
  534. "optional": false,
  535. "field": "order_id",
  536. "description": "<p>订单ID</p>"
  537. }
  538. ]
  539. }
  540. },
  541. "success": {
  542. "examples": [
  543. {
  544. "title": "Success-Response:",
  545. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"id\": 27,\n \"out_trade_no\": \"xxg1531993028\", //订单编号\n \"username\": \"lee\", //联系人\n \"phone\": \"13407570876\", //联系电话\n \"email\": \"154@qq.com\", //邮箱\n \"schedule_time\": \"2018-07-19 11:00:00\", //预约时间\n \"status\": 0,\n \"store_id\": \"1\",\n \"storename\": \"青羊店\", //店铺名称\n \"product_name\": \"证件照\", //产品名称\n \"service_time\": \"约120分钟\", //服务时长\n \"price\": 199, //应付金额\n \"deposit\": 100 //定金\n }\n\n}",
  546. "type": "json"
  547. }
  548. ]
  549. },
  550. "error": {
  551. "examples": [
  552. {
  553. "title": "Error-Response:",
  554. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  555. "type": "json"
  556. }
  557. ]
  558. },
  559. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  560. "groupTitle": "Order",
  561. "name": "GetApiHomeOrder"
  562. },
  563. {
  564. "type": "get",
  565. "url": "/api/home/refund",
  566. "title": "申请退款",
  567. "description": "<p>申请退款</p>",
  568. "group": "Order",
  569. "permission": [
  570. {
  571. "name": "Passport"
  572. }
  573. ],
  574. "version": "0.1.0",
  575. "parameter": {
  576. "fields": {
  577. "Parameter": [
  578. {
  579. "group": "Parameter",
  580. "type": "int",
  581. "optional": false,
  582. "field": "order_id",
  583. "description": "<p>产品规格ID,订单中获取</p>"
  584. }
  585. ]
  586. }
  587. },
  588. "success": {
  589. "examples": [
  590. {
  591. "title": "Success-Response:",
  592. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n \"code\": 200,\n \"msg\": \"退款已申请,请等待商家审核!\"\n }\n}",
  593. "type": "json"
  594. }
  595. ]
  596. },
  597. "error": {
  598. "examples": [
  599. {
  600. "title": "Error-Response:",
  601. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}\n\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n \"code\": 10003,\n \"msg\": \"该订单不能退款,如有疑问,请联系商家!\"\n }\n}\n可能出现的错误代码:\n 1000 CLIENT_WRONG_PARAMS 传入参数不正确",
  602. "type": "json"
  603. }
  604. ]
  605. },
  606. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  607. "groupTitle": "Order",
  608. "name": "GetApiHomeRefund"
  609. },
  610. {
  611. "type": "post",
  612. "url": "/api/home/pay",
  613. "title": "订单支付",
  614. "description": "<p>订单支付</p>",
  615. "group": "Order",
  616. "permission": [
  617. {
  618. "name": "Passport"
  619. }
  620. ],
  621. "version": "0.1.0",
  622. "parameter": {
  623. "fields": {
  624. "Parameter": [
  625. {
  626. "group": "Parameter",
  627. "type": "string",
  628. "optional": false,
  629. "field": "orderid",
  630. "description": "<p>订单号,创建订单后返回</p>"
  631. },
  632. {
  633. "group": "Parameter",
  634. "type": "int",
  635. "optional": true,
  636. "field": "couponid",
  637. "description": "<p>优惠券id</p>"
  638. },
  639. {
  640. "group": "Parameter",
  641. "type": "int",
  642. "optional": true,
  643. "field": "cardid",
  644. "description": "<p>抵扣卡id(抵扣卡和优惠券不能同时使用)</p>"
  645. }
  646. ]
  647. }
  648. },
  649. "success": {
  650. "examples": [
  651. {
  652. "title": "Success-Response:",
  653. "content": "HTTP/1.1 200 OK\n{\n \"status\": true,\n \"status_code\": 0,\n \"message\": \"\",\n \"data\": {\n \"appId\":\"wx1c2357232cd25f65\",\n \"timeStamp\":\"1524907589\",\n \"nonceStr\":\"5ae43e45eb499\",\n \"package\":\"prepay_id=wx28172629917401724160128f0238805782\",\n \"signType\":\"MD5\",\n \"paySign\":\"8E9CF26B2B83C22471D023CBBDC36EDF\"\n }\n}",
  654. "type": "json"
  655. }
  656. ]
  657. },
  658. "error": {
  659. "examples": [
  660. {
  661. "title": "Error-Response:",
  662. "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 传入参数不正确",
  663. "type": "json"
  664. }
  665. ]
  666. },
  667. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  668. "groupTitle": "Order",
  669. "name": "PostApiHomePay"
  670. },
  671. {
  672. "type": "get",
  673. "url": "/api/home/getproduct",
  674. "title": "获取产品详情及规格",
  675. "description": "<p>获取产品详情及规格</p>",
  676. "group": "Product",
  677. "permission": [
  678. {
  679. "name": "none"
  680. }
  681. ],
  682. "version": "0.1.0",
  683. "parameter": {
  684. "fields": {
  685. "Parameter": [
  686. {
  687. "group": "Parameter",
  688. "type": "int",
  689. "optional": false,
  690. "field": "id",
  691. "description": "<p>产品的id</p>"
  692. }
  693. ]
  694. }
  695. },
  696. "success": {
  697. "examples": [
  698. {
  699. "title": "Success-Response:",
  700. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"id\": 1,\n \"name\": \"证件照\",\n \"detail\": \"\", //产品详情\n \"img\": \"/upload/images/20180712/696aa5b6187bd8b1e7eb4f7962a5a3cb.jpg\",\n \"spec\": [ //规格\n ...\n {\n \"id\": 1,\n \"name\": \"证件照\",\n \"img\": \"\",\n \"category_id\": 1,\n \"origin_price\": 299, //原价\n \"current_price\": 199, //折后价\n\n },\n ...\n ]\n }\n}",
  701. "type": "json"
  702. }
  703. ]
  704. },
  705. "error": {
  706. "examples": [
  707. {
  708. "title": "Error-Response:",
  709. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  710. "type": "json"
  711. }
  712. ]
  713. },
  714. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  715. "groupTitle": "Product",
  716. "name": "GetApiHomeGetproduct"
  717. },
  718. {
  719. "type": "get",
  720. "url": "/api/home/getproducts",
  721. "title": "获取产品列表",
  722. "description": "<p>获取产品列表</p>",
  723. "group": "Product",
  724. "permission": [
  725. {
  726. "name": "None"
  727. }
  728. ],
  729. "version": "0.1.0",
  730. "success": {
  731. "examples": [
  732. {
  733. "title": "Success-Response:",
  734. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": [\n...\n {\n \"id\": 2,\n \"name\": \"履历照\",\n \"img\": \"/upload/images/20180712/ab83f15f31ba33e17e195a20d5307e37.jpg\"\n },\n...\n]\n}",
  735. "type": "json"
  736. }
  737. ]
  738. },
  739. "error": {
  740. "examples": [
  741. {
  742. "title": "Error-Response:",
  743. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  744. "type": "json"
  745. }
  746. ]
  747. },
  748. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  749. "groupTitle": "Product",
  750. "name": "GetApiHomeGetproducts"
  751. },
  752. {
  753. "type": "get",
  754. "url": "/api/home/getschedule",
  755. "title": "获取店铺排期",
  756. "description": "<p>获取店铺排期</p>",
  757. "group": "Store",
  758. "permission": [
  759. {
  760. "name": "None"
  761. }
  762. ],
  763. "version": "0.1.0",
  764. "parameter": {
  765. "fields": {
  766. "Parameter": [
  767. {
  768. "group": "Parameter",
  769. "type": "string",
  770. "optional": false,
  771. "field": "day",
  772. "description": "<p>要预约的日期,如:2018-7-19</p>"
  773. },
  774. {
  775. "group": "Parameter",
  776. "type": "string",
  777. "optional": false,
  778. "field": "store_id",
  779. "description": "<p>要预约的店铺ID</p>"
  780. }
  781. ]
  782. }
  783. },
  784. "success": {
  785. "examples": [
  786. {
  787. "title": "Success-Response:",
  788. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": {\n \"am_schedule\": [\n {\n \"time\": \"2018-07-19 09:00:00\",\n \"remain\": 3 可预订人数,0表示该时间段人数已满\n },\n {\n \"time\": \"2018-07-19 10:00:00\",\n \"remain\": 0\n },\n {\n \"time\": \"2018-07-19 11:00:00\",\n \"remain\": 3\n }\n ],\n \"pm_schedule\": [\n {\n \"time\": \"2018-07-19 14:00:00\",\n \"remain\": 3\n },\n {\n \"time\": \"2018-07-19 15:00:00\",\n \"remain\": 0\n },\n {\n \"time\": \"2018-07-19 16:00:00\",\n \"remain\": 3\n }\n ]\n\n\n}",
  789. "type": "json"
  790. }
  791. ]
  792. },
  793. "error": {
  794. "examples": [
  795. {
  796. "title": "Error-Response:",
  797. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  798. "type": "json"
  799. }
  800. ]
  801. },
  802. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  803. "groupTitle": "Store",
  804. "name": "GetApiHomeGetschedule"
  805. },
  806. {
  807. "type": "get",
  808. "url": "/api/home/getstores",
  809. "title": "获取店铺列表",
  810. "description": "<p>获取店铺列表</p>",
  811. "group": "Store",
  812. "permission": [
  813. {
  814. "name": "None"
  815. }
  816. ],
  817. "version": "0.1.0",
  818. "success": {
  819. "examples": [
  820. {
  821. "title": "Success-Response:",
  822. "content": "HTTP/1.1 200 OK\n{\n \"state\": true,\n \"code\": 0,\n \"message\": \"\",\n \"data\": [\n ...\n {\n \"id\": 1,\n \"name\": \"青羊店\",\n \"img\": \"/upload/images/20180712/696aa5b6187bd8b1e7eb4f7962a5a3cb.jpg\",\n \"address\": \"四川省成都市青羊区新华西路街道江汉路33号新华宾馆\",\n \"phone\": \"18380257014\",\n \"lat\": \"30.675999\", //店铺纬度\n \"lon\": \"104.064465\" //店铺经度\n },\n ...\n ]\n}",
  823. "type": "json"
  824. }
  825. ]
  826. },
  827. "error": {
  828. "examples": [
  829. {
  830. "title": "Error-Response:",
  831. "content": "HTTP/1.1 400 Bad Request\n{\n \"state\": false,\n \"code\": 1000,\n \"message\": \"传入参数不正确\",\n \"data\": null or []\n}",
  832. "type": "json"
  833. }
  834. ]
  835. },
  836. "filename": "app/Http/Controllers/Api/V1/HomeController.php",
  837. "groupTitle": "Store",
  838. "name": "GetApiHomeGetstores"
  839. }
  840. ] });