api_data.js 32 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177
  1. define({ "api": [
  2. {
  3. "type": "get",
  4. "url": "common",
  5. "title": "公共参数说明",
  6. "version": "1.0.0",
  7. "name": "common",
  8. "group": "Common",
  9. "description": "<p>介绍公共参数</p>",
  10. "parameter": {
  11. "fields": {
  12. "Parameter": [
  13. {
  14. "group": "Parameter",
  15. "type": "Number",
  16. "optional": false,
  17. "field": "json",
  18. "description": "<p>是否返回json格式的数据1为返回2为不返回</p>"
  19. },
  20. {
  21. "group": "Parameter",
  22. "type": "Number",
  23. "optional": false,
  24. "field": "signature",
  25. "description": "<p>用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地</p>"
  26. },
  27. {
  28. "group": "Parameter",
  29. "type": "Number",
  30. "optional": false,
  31. "field": "pg",
  32. "description": "<p>用于分页传参,比如请求第二页数据,则加上该参数pg=2,没有分页和瀑布流不需要该参数</p>"
  33. }
  34. ]
  35. }
  36. },
  37. "success": {
  38. "fields": {
  39. "Success 200": [
  40. {
  41. "group": "Success 200",
  42. "type": "Number",
  43. "optional": false,
  44. "field": "status",
  45. "description": "<p>状态,1为有效2为无效</p>"
  46. },
  47. {
  48. "group": "Success 200",
  49. "type": "String",
  50. "optional": false,
  51. "field": "msg",
  52. "description": "<p>请求的数据是否成功的提示</p>"
  53. },
  54. {
  55. "group": "Success 200",
  56. "type": "String",
  57. "optional": false,
  58. "field": "data",
  59. "description": "<p>如果status为1,data有值</p>"
  60. },
  61. {
  62. "group": "Success 200",
  63. "type": "Object[]",
  64. "optional": false,
  65. "field": "page",
  66. "description": "<p>分页信息</p>"
  67. },
  68. {
  69. "group": "Success 200",
  70. "type": "Number",
  71. "optional": false,
  72. "field": "page.total",
  73. "description": "<p>分页总数</p>"
  74. },
  75. {
  76. "group": "Success 200",
  77. "type": "Number",
  78. "optional": false,
  79. "field": "page.current_page",
  80. "description": "<p>当前页</p>"
  81. },
  82. {
  83. "group": "Success 200",
  84. "type": "Number",
  85. "optional": false,
  86. "field": "page.total_page",
  87. "description": "<p>总页数</p>"
  88. },
  89. {
  90. "group": "Success 200",
  91. "type": "Number",
  92. "optional": false,
  93. "field": "page.next_page",
  94. "description": "<p>下一页</p>"
  95. },
  96. {
  97. "group": "Success 200",
  98. "type": "Number",
  99. "optional": false,
  100. "field": "page.prev_page",
  101. "description": "<p>上一页</p>"
  102. },
  103. {
  104. "group": "Success 200",
  105. "type": "Number",
  106. "optional": false,
  107. "field": "page.status",
  108. "description": "<p>是否有下一页数据,0为没有</p>"
  109. }
  110. ]
  111. }
  112. },
  113. "filename": "/root/input/doc/apidoc.php",
  114. "groupTitle": "Common"
  115. },
  116. {
  117. "type": "get",
  118. "url": "passport/?l=applet.bind",
  119. "title": "用户登录",
  120. "version": "1.0.0",
  121. "name": "applet_bind",
  122. "group": "Passport",
  123. "description": "<p>用户登录</p>",
  124. "parameter": {
  125. "fields": {
  126. "Parameter": [
  127. {
  128. "group": "Parameter",
  129. "type": "String",
  130. "optional": false,
  131. "field": "code",
  132. "description": "<p>微信登录返回的code</p>"
  133. }
  134. ]
  135. }
  136. },
  137. "success": {
  138. "fields": {
  139. "Success 200": [
  140. {
  141. "group": "Success 200",
  142. "type": "Number",
  143. "optional": false,
  144. "field": "vid",
  145. "description": "<p>微信id,请保存在本地</p>"
  146. },
  147. {
  148. "group": "Success 200",
  149. "type": "Number",
  150. "optional": false,
  151. "field": "uid",
  152. "description": "<p>用户id,请保存在本地</p>"
  153. },
  154. {
  155. "group": "Success 200",
  156. "type": "String",
  157. "optional": false,
  158. "field": "signature",
  159. "description": "<p>用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地</p>"
  160. }
  161. ]
  162. }
  163. },
  164. "filename": "/root/input/doc/apidoc.php",
  165. "groupTitle": "Passport"
  166. },
  167. {
  168. "type": "get",
  169. "url": "passport/?l=applet.bind_mobile",
  170. "title": "绑定手机号-验证码绑定",
  171. "version": "1.0.0",
  172. "name": "applet_bind_mobile",
  173. "group": "Passport",
  174. "description": "<p>绑定手机号-验证码绑定</p>",
  175. "parameter": {
  176. "fields": {
  177. "Parameter": [
  178. {
  179. "group": "Parameter",
  180. "type": "Number",
  181. "optional": false,
  182. "field": "uid",
  183. "description": "<p>用户id</p>"
  184. },
  185. {
  186. "group": "Parameter",
  187. "type": "Number",
  188. "optional": false,
  189. "field": "mobile",
  190. "description": "<p>手机号</p>"
  191. },
  192. {
  193. "group": "Parameter",
  194. "type": "String",
  195. "optional": false,
  196. "field": "mcode",
  197. "description": "<p>验证码</p>"
  198. },
  199. {
  200. "group": "Parameter",
  201. "type": "String",
  202. "optional": false,
  203. "field": "signature",
  204. "description": "<p>signature</p>"
  205. }
  206. ]
  207. }
  208. },
  209. "success": {
  210. "fields": {
  211. "Success 200": [
  212. {
  213. "group": "Success 200",
  214. "type": "Number",
  215. "optional": false,
  216. "field": "uid",
  217. "description": "<p>用户id,请保存在本地</p>"
  218. },
  219. {
  220. "group": "Success 200",
  221. "type": "String",
  222. "optional": false,
  223. "field": "signature",
  224. "description": "<p>用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地</p>"
  225. }
  226. ]
  227. }
  228. },
  229. "filename": "/root/input/doc/apidoc.php",
  230. "groupTitle": "Passport"
  231. },
  232. {
  233. "type": "get",
  234. "url": "passport/?l=applet.mobile",
  235. "title": "更新用户手机号-微信绑定",
  236. "version": "1.0.0",
  237. "name": "applet_mobile",
  238. "group": "Passport",
  239. "description": "<p>更新用户手机号-微信绑定</p>",
  240. "parameter": {
  241. "fields": {
  242. "Parameter": [
  243. {
  244. "group": "Parameter",
  245. "type": "String",
  246. "optional": false,
  247. "field": "iv",
  248. "description": "<p>微信的加密参数</p>"
  249. },
  250. {
  251. "group": "Parameter",
  252. "type": "String",
  253. "optional": false,
  254. "field": "encryptedData",
  255. "description": "<p>微信的加密参数</p>"
  256. },
  257. {
  258. "group": "Parameter",
  259. "type": "Number",
  260. "optional": false,
  261. "field": "vid",
  262. "description": "<p>微信id</p>"
  263. },
  264. {
  265. "group": "Parameter",
  266. "type": "Number",
  267. "optional": false,
  268. "field": "uid",
  269. "description": "<p>用户id</p>"
  270. },
  271. {
  272. "group": "Parameter",
  273. "type": "String",
  274. "optional": false,
  275. "field": "signature",
  276. "description": "<p>signature</p>"
  277. }
  278. ]
  279. }
  280. },
  281. "success": {
  282. "fields": {
  283. "Success 200": [
  284. {
  285. "group": "Success 200",
  286. "type": "Number",
  287. "optional": false,
  288. "field": "vid",
  289. "description": "<p>微信id,请保存在本地</p>"
  290. },
  291. {
  292. "group": "Success 200",
  293. "type": "Number",
  294. "optional": false,
  295. "field": "uid",
  296. "description": "<p>用户id,请保存在本地</p>"
  297. },
  298. {
  299. "group": "Success 200",
  300. "type": "String",
  301. "optional": false,
  302. "field": "signature",
  303. "description": "<p>用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地</p>"
  304. }
  305. ]
  306. }
  307. },
  308. "filename": "/root/input/doc/apidoc.php",
  309. "groupTitle": "Passport"
  310. },
  311. {
  312. "type": "get",
  313. "url": "passport/?l=applet.update",
  314. "title": "更新用户信息",
  315. "version": "1.0.0",
  316. "name": "applet_update",
  317. "group": "Passport",
  318. "description": "<p>更新用户信息</p>",
  319. "parameter": {
  320. "fields": {
  321. "Parameter": [
  322. {
  323. "group": "Parameter",
  324. "type": "String",
  325. "optional": false,
  326. "field": "nickname",
  327. "description": "<p>用户昵称</p>"
  328. },
  329. {
  330. "group": "Parameter",
  331. "type": "String",
  332. "optional": false,
  333. "field": "avatarurl",
  334. "description": "<p>用户头像</p>"
  335. },
  336. {
  337. "group": "Parameter",
  338. "type": "String",
  339. "optional": false,
  340. "field": "iv",
  341. "description": "<p>微信的加密参数</p>"
  342. },
  343. {
  344. "group": "Parameter",
  345. "type": "String",
  346. "optional": false,
  347. "field": "encryptedData",
  348. "description": "<p>微信的加密参数</p>"
  349. },
  350. {
  351. "group": "Parameter",
  352. "type": "Number",
  353. "optional": false,
  354. "field": "vid",
  355. "description": "<p>微信id</p>"
  356. },
  357. {
  358. "group": "Parameter",
  359. "type": "Number",
  360. "optional": false,
  361. "field": "uid",
  362. "description": "<p>用户id</p>"
  363. },
  364. {
  365. "group": "Parameter",
  366. "type": "String",
  367. "optional": false,
  368. "field": "signature",
  369. "description": "<p>signature</p>"
  370. }
  371. ]
  372. }
  373. },
  374. "success": {
  375. "fields": {
  376. "Success 200": [
  377. {
  378. "group": "Success 200",
  379. "type": "Number",
  380. "optional": false,
  381. "field": "vid",
  382. "description": "<p>微信id,请保存在本地</p>"
  383. },
  384. {
  385. "group": "Success 200",
  386. "type": "Number",
  387. "optional": false,
  388. "field": "uid",
  389. "description": "<p>用户id,请保存在本地</p>"
  390. },
  391. {
  392. "group": "Success 200",
  393. "type": "String",
  394. "optional": false,
  395. "field": "signature",
  396. "description": "<p>用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地</p>"
  397. }
  398. ]
  399. }
  400. },
  401. "filename": "/root/input/doc/apidoc.php",
  402. "groupTitle": "Passport"
  403. },
  404. {
  405. "type": "get",
  406. "url": "passport/?l=reg.getMCode",
  407. "title": "获取手机验证码",
  408. "version": "1.0.0",
  409. "name": "reg_getMCode",
  410. "group": "Passport",
  411. "description": "<p>获取手机验证码</p>",
  412. "parameter": {
  413. "fields": {
  414. "Parameter": [
  415. {
  416. "group": "Parameter",
  417. "type": "Number",
  418. "optional": false,
  419. "field": "mobile",
  420. "description": "<p>手机号</p>"
  421. },
  422. {
  423. "group": "Parameter",
  424. "type": "String",
  425. "optional": false,
  426. "field": "signature",
  427. "description": "<p>signature</p>"
  428. }
  429. ]
  430. }
  431. },
  432. "success": {
  433. "fields": {
  434. "Success 200": [
  435. {
  436. "group": "Success 200",
  437. "type": "String",
  438. "optional": false,
  439. "field": "msg",
  440. "description": "<p>验证码已发送至您的手机,请注意查收,十分钟之内有效</p>"
  441. }
  442. ]
  443. }
  444. },
  445. "filename": "/root/input/doc/apidoc.php",
  446. "groupTitle": "Passport"
  447. },
  448. {
  449. "type": "get",
  450. "url": "product/?l=api.addAddress",
  451. "title": "添加收货地址",
  452. "version": "1.0.0",
  453. "name": "api_addAddress",
  454. "group": "Product",
  455. "description": "<p>添加收货地址</p>",
  456. "parameter": {
  457. "fields": {
  458. "Parameter": [
  459. {
  460. "group": "Parameter",
  461. "type": "String",
  462. "optional": false,
  463. "field": "signature",
  464. "description": "<p>signature</p>"
  465. },
  466. {
  467. "group": "Parameter",
  468. "type": "String",
  469. "optional": false,
  470. "field": "name",
  471. "description": "<p>收货人姓名</p>"
  472. },
  473. {
  474. "group": "Parameter",
  475. "type": "String",
  476. "optional": false,
  477. "field": "address",
  478. "description": "<p>收货人地址</p>"
  479. },
  480. {
  481. "group": "Parameter",
  482. "type": "String",
  483. "optional": false,
  484. "field": "mobile",
  485. "description": "<p>收货人联系电话</p>"
  486. }
  487. ]
  488. }
  489. },
  490. "success": {
  491. "fields": {
  492. "Success 200": [
  493. {
  494. "group": "Success 200",
  495. "type": "String",
  496. "optional": false,
  497. "field": "data",
  498. "description": "<p>返回ok</p>"
  499. }
  500. ]
  501. }
  502. },
  503. "filename": "/root/input/doc/apidoc.php",
  504. "groupTitle": "Product"
  505. },
  506. {
  507. "type": "get",
  508. "url": "product/?l=api.addCarts",
  509. "title": "添加产品到购物车",
  510. "version": "1.0.0",
  511. "name": "api_addCarts",
  512. "group": "Product",
  513. "description": "<p>添加产品到购物车</p>",
  514. "parameter": {
  515. "fields": {
  516. "Parameter": [
  517. {
  518. "group": "Parameter",
  519. "type": "String",
  520. "optional": false,
  521. "field": "signature",
  522. "description": "<p>signature</p>"
  523. },
  524. {
  525. "group": "Parameter",
  526. "type": "String",
  527. "optional": false,
  528. "field": "product_id",
  529. "description": "<p>产品id</p>"
  530. },
  531. {
  532. "group": "Parameter",
  533. "type": "String",
  534. "optional": false,
  535. "field": "num",
  536. "description": "<p>数量</p>"
  537. }
  538. ]
  539. }
  540. },
  541. "success": {
  542. "fields": {
  543. "Success 200": [
  544. {
  545. "group": "Success 200",
  546. "type": "String",
  547. "optional": false,
  548. "field": "data",
  549. "description": "<p>返回ok</p>"
  550. }
  551. ]
  552. }
  553. },
  554. "filename": "/root/input/doc/apidoc.php",
  555. "groupTitle": "Product"
  556. },
  557. {
  558. "type": "get",
  559. "url": "product/?l=api.buy",
  560. "title": "发起微信支付",
  561. "version": "1.0.0",
  562. "name": "api_buy",
  563. "group": "Product",
  564. "description": "<p>发起微信支付</p>",
  565. "parameter": {
  566. "fields": {
  567. "Parameter": [
  568. {
  569. "group": "Parameter",
  570. "type": "String",
  571. "optional": false,
  572. "field": "signature",
  573. "description": "<p>signature</p>"
  574. },
  575. {
  576. "group": "Parameter",
  577. "type": "String",
  578. "optional": false,
  579. "field": "product_id",
  580. "description": "<p>产品id,多个用逗号隔开</p>"
  581. },
  582. {
  583. "group": "Parameter",
  584. "type": "String",
  585. "optional": false,
  586. "field": "num",
  587. "description": "<p>产品数量,多个用逗号隔开</p>"
  588. }
  589. ]
  590. }
  591. },
  592. "success": {
  593. "fields": {
  594. "Success 200": [
  595. {
  596. "group": "Success 200",
  597. "type": "Object[]",
  598. "optional": false,
  599. "field": "pay",
  600. "description": "<p>微信支付返回的数据</p>"
  601. },
  602. {
  603. "group": "Success 200",
  604. "type": "String",
  605. "optional": false,
  606. "field": "pay.time",
  607. "description": "<p>服务器时间戳</p>"
  608. },
  609. {
  610. "group": "Success 200",
  611. "type": "String",
  612. "optional": false,
  613. "field": "pay.nonce_str",
  614. "description": "<p>随机字符串</p>"
  615. },
  616. {
  617. "group": "Success 200",
  618. "type": "String",
  619. "optional": false,
  620. "field": "pay.prepay_id",
  621. "description": "<p>统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package</p>"
  622. },
  623. {
  624. "group": "Success 200",
  625. "type": "String",
  626. "optional": false,
  627. "field": "pay.sign_type",
  628. "description": "<p>签名算法</p>"
  629. },
  630. {
  631. "group": "Success 200",
  632. "type": "String",
  633. "optional": false,
  634. "field": "pay.sign",
  635. "description": "<p>签名</p>"
  636. }
  637. ]
  638. }
  639. },
  640. "filename": "/root/input/doc/apidoc.php",
  641. "groupTitle": "Product"
  642. },
  643. {
  644. "type": "get",
  645. "url": "product/?l=api.carts",
  646. "title": "获取购物车列表",
  647. "version": "1.0.0",
  648. "name": "api_carts",
  649. "group": "Product",
  650. "description": "<p>获取购物车列表</p>",
  651. "parameter": {
  652. "fields": {
  653. "Parameter": [
  654. {
  655. "group": "Parameter",
  656. "type": "String",
  657. "optional": false,
  658. "field": "signature",
  659. "description": "<p>signature</p>"
  660. }
  661. ]
  662. }
  663. },
  664. "success": {
  665. "fields": {
  666. "Success 200": [
  667. {
  668. "group": "Success 200",
  669. "type": "Object[]",
  670. "optional": false,
  671. "field": "carts",
  672. "description": "<p>购物车信息</p>"
  673. },
  674. {
  675. "group": "Success 200",
  676. "type": "String",
  677. "optional": false,
  678. "field": "carts.product",
  679. "description": "<p>产品信息</p>"
  680. },
  681. {
  682. "group": "Success 200",
  683. "type": "String",
  684. "optional": false,
  685. "field": "carts.num",
  686. "description": "<p>数量</p>"
  687. },
  688. {
  689. "group": "Success 200",
  690. "type": "Object[]",
  691. "optional": false,
  692. "field": "address",
  693. "description": "<p>收货地址</p>"
  694. },
  695. {
  696. "group": "Success 200",
  697. "type": "String",
  698. "optional": false,
  699. "field": "address.name",
  700. "description": "<p>收货人姓名</p>"
  701. },
  702. {
  703. "group": "Success 200",
  704. "type": "String",
  705. "optional": false,
  706. "field": "address.address",
  707. "description": "<p>收货人地址</p>"
  708. },
  709. {
  710. "group": "Success 200",
  711. "type": "String",
  712. "optional": false,
  713. "field": "address.mobile",
  714. "description": "<p>收货人联系电话</p>"
  715. }
  716. ]
  717. }
  718. },
  719. "filename": "/root/input/doc/apidoc.php",
  720. "groupTitle": "Product"
  721. },
  722. {
  723. "type": "get",
  724. "url": "product/?l=api.code",
  725. "title": "提交兑换码",
  726. "version": "1.0.0",
  727. "name": "api_code",
  728. "group": "Product",
  729. "description": "<p>提交兑换码</p>",
  730. "parameter": {
  731. "fields": {
  732. "Parameter": [
  733. {
  734. "group": "Parameter",
  735. "type": "String",
  736. "optional": false,
  737. "field": "signature",
  738. "description": "<p>signature</p>"
  739. },
  740. {
  741. "group": "Parameter",
  742. "type": "String",
  743. "optional": false,
  744. "field": "product_id",
  745. "description": "<p>产品id</p>"
  746. },
  747. {
  748. "group": "Parameter",
  749. "type": "String",
  750. "optional": false,
  751. "field": "code",
  752. "description": "<p>兑换码</p>"
  753. }
  754. ]
  755. }
  756. },
  757. "filename": "/root/input/doc/apidoc.php",
  758. "groupTitle": "Product"
  759. },
  760. {
  761. "type": "get",
  762. "url": "product/?l=api.home",
  763. "title": "获取首页数据",
  764. "version": "1.0.0",
  765. "name": "api_home",
  766. "group": "Product",
  767. "description": "<p>获取首页数据</p>",
  768. "parameter": {
  769. "fields": {
  770. "Parameter": [
  771. {
  772. "group": "Parameter",
  773. "type": "String",
  774. "optional": false,
  775. "field": "signature",
  776. "description": "<p>signature</p>"
  777. }
  778. ]
  779. }
  780. },
  781. "success": {
  782. "fields": {
  783. "Success 200": [
  784. {
  785. "group": "Success 200",
  786. "type": "Number",
  787. "optional": false,
  788. "field": "uid",
  789. "description": "<p>用户id 所有Service接口中都有该项</p>"
  790. },
  791. {
  792. "group": "Success 200",
  793. "type": "Object[]",
  794. "optional": false,
  795. "field": "config",
  796. "description": "<p>基本配置 所有Service接口中都有该项</p>"
  797. },
  798. {
  799. "group": "Success 200",
  800. "type": "String",
  801. "optional": false,
  802. "field": "config.name",
  803. "description": "<p>小程序名称</p>"
  804. },
  805. {
  806. "group": "Success 200",
  807. "type": "String",
  808. "optional": false,
  809. "field": "config.logo",
  810. "description": "<p>小程序logo</p>"
  811. },
  812. {
  813. "group": "Success 200",
  814. "type": "Object[]",
  815. "optional": false,
  816. "field": "focus",
  817. "description": "<p>焦点图 暂时无用</p>"
  818. },
  819. {
  820. "group": "Success 200",
  821. "type": "String",
  822. "optional": false,
  823. "field": "focus.name",
  824. "description": "<p>名称</p>"
  825. },
  826. {
  827. "group": "Success 200",
  828. "type": "String",
  829. "optional": false,
  830. "field": "focus.pic",
  831. "description": "<p>图片</p>"
  832. },
  833. {
  834. "group": "Success 200",
  835. "type": "Object[]",
  836. "optional": false,
  837. "field": "product",
  838. "description": "<p>产品列表</p>"
  839. },
  840. {
  841. "group": "Success 200",
  842. "type": "String",
  843. "optional": false,
  844. "field": "product.id",
  845. "description": "<p>产品id</p>"
  846. },
  847. {
  848. "group": "Success 200",
  849. "type": "String",
  850. "optional": false,
  851. "field": "product.name",
  852. "description": "<p>名称</p>"
  853. },
  854. {
  855. "group": "Success 200",
  856. "type": "String",
  857. "optional": false,
  858. "field": "product.pic",
  859. "description": "<p>产品封面</p>"
  860. },
  861. {
  862. "group": "Success 200",
  863. "type": "String",
  864. "optional": false,
  865. "field": "product.focus",
  866. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  867. },
  868. {
  869. "group": "Success 200",
  870. "type": "String",
  871. "optional": false,
  872. "field": "product.content",
  873. "description": "<p>内容</p>"
  874. },
  875. {
  876. "group": "Success 200",
  877. "type": "String",
  878. "optional": false,
  879. "field": "product.price",
  880. "description": "<p>显示价格</p>"
  881. },
  882. {
  883. "group": "Success 200",
  884. "type": "Number",
  885. "optional": false,
  886. "field": "product.pay_price",
  887. "description": "<p>支付价格</p>"
  888. }
  889. ]
  890. }
  891. },
  892. "filename": "/root/input/doc/apidoc.php",
  893. "groupTitle": "Product"
  894. },
  895. {
  896. "type": "get",
  897. "url": "product/?l=api.order",
  898. "title": "我的订单",
  899. "version": "1.0.0",
  900. "name": "api_order",
  901. "group": "Product",
  902. "description": "<p>我的订单</p>",
  903. "parameter": {
  904. "fields": {
  905. "Parameter": [
  906. {
  907. "group": "Parameter",
  908. "type": "String",
  909. "optional": false,
  910. "field": "signature",
  911. "description": "<p>signature</p>"
  912. }
  913. ]
  914. }
  915. },
  916. "success": {
  917. "fields": {
  918. "Success 200": [
  919. {
  920. "group": "Success 200",
  921. "type": "Object[]",
  922. "optional": false,
  923. "field": "order",
  924. "description": "<p>订单信息</p>"
  925. },
  926. {
  927. "group": "Success 200",
  928. "type": "String",
  929. "optional": false,
  930. "field": "order.name",
  931. "description": "<p>名称</p>"
  932. },
  933. {
  934. "group": "Success 200",
  935. "type": "String",
  936. "optional": false,
  937. "field": "order.order_id",
  938. "description": "<p>订单编号</p>"
  939. },
  940. {
  941. "group": "Success 200",
  942. "type": "String",
  943. "optional": false,
  944. "field": "order.del_status",
  945. "description": "<p>产品在线状态1为在线2为已下线</p>"
  946. }
  947. ]
  948. }
  949. },
  950. "filename": "/root/input/doc/apidoc.php",
  951. "groupTitle": "Product"
  952. },
  953. {
  954. "type": "get",
  955. "url": "product/?l=api.poster",
  956. "title": "生成海报",
  957. "version": "1.0.0",
  958. "name": "api_poster",
  959. "group": "Product",
  960. "description": "<p>生成海报</p>",
  961. "parameter": {
  962. "fields": {
  963. "Parameter": [
  964. {
  965. "group": "Parameter",
  966. "type": "String",
  967. "optional": false,
  968. "field": "signature",
  969. "description": "<p>signature</p>"
  970. },
  971. {
  972. "group": "Parameter",
  973. "type": "String",
  974. "optional": false,
  975. "field": "product_id",
  976. "description": "<p>产品id</p>"
  977. },
  978. {
  979. "group": "Parameter",
  980. "type": "String",
  981. "optional": false,
  982. "field": "path",
  983. "description": "<p>生成的二维码跳转的path,请不要带上参数,该path会自动加上scene=uid,product_id,请直接在onLoad 的方法中解析该参数:const scene = decodeURIComponent(options.scene);scene = scene.split(',');var uid = scene[0];var product_id = scene[1];如果有该参数,请直接跳转到产品详情页。</p>"
  984. }
  985. ]
  986. }
  987. },
  988. "success": {
  989. "fields": {
  990. "Success 200": [
  991. {
  992. "group": "Success 200",
  993. "type": "String",
  994. "optional": false,
  995. "field": "pic",
  996. "description": "<p>直接返回海报图片</p>"
  997. }
  998. ]
  999. }
  1000. },
  1001. "filename": "/root/input/doc/apidoc.php",
  1002. "groupTitle": "Product"
  1003. },
  1004. {
  1005. "type": "get",
  1006. "url": "product/?l=api.view",
  1007. "title": "获取产品详情",
  1008. "version": "1.0.0",
  1009. "name": "api_view",
  1010. "group": "Product",
  1011. "description": "<p>获取产品详情</p>",
  1012. "parameter": {
  1013. "fields": {
  1014. "Parameter": [
  1015. {
  1016. "group": "Parameter",
  1017. "type": "String",
  1018. "optional": false,
  1019. "field": "signature",
  1020. "description": "<p>signature</p>"
  1021. },
  1022. {
  1023. "group": "Parameter",
  1024. "type": "String",
  1025. "optional": false,
  1026. "field": "id",
  1027. "description": "<p>产品id</p>"
  1028. }
  1029. ]
  1030. }
  1031. },
  1032. "success": {
  1033. "fields": {
  1034. "Success 200": [
  1035. {
  1036. "group": "Success 200",
  1037. "type": "Object[]",
  1038. "optional": false,
  1039. "field": "focus",
  1040. "description": "<p>焦点图</p>"
  1041. },
  1042. {
  1043. "group": "Success 200",
  1044. "type": "String",
  1045. "optional": false,
  1046. "field": "focus.name",
  1047. "description": "<p>名称</p>"
  1048. },
  1049. {
  1050. "group": "Success 200",
  1051. "type": "String",
  1052. "optional": false,
  1053. "field": "focus.pic",
  1054. "description": "<p>图片</p>"
  1055. },
  1056. {
  1057. "group": "Success 200",
  1058. "type": "Object[]",
  1059. "optional": false,
  1060. "field": "product",
  1061. "description": "<p>产品信息</p>"
  1062. },
  1063. {
  1064. "group": "Success 200",
  1065. "type": "String",
  1066. "optional": false,
  1067. "field": "product.id",
  1068. "description": "<p>产品id</p>"
  1069. },
  1070. {
  1071. "group": "Success 200",
  1072. "type": "String",
  1073. "optional": false,
  1074. "field": "product.name",
  1075. "description": "<p>名称</p>"
  1076. },
  1077. {
  1078. "group": "Success 200",
  1079. "type": "String",
  1080. "optional": false,
  1081. "field": "product.pic",
  1082. "description": "<p>产品封面</p>"
  1083. },
  1084. {
  1085. "group": "Success 200",
  1086. "type": "String",
  1087. "optional": false,
  1088. "field": "product.focus",
  1089. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  1090. },
  1091. {
  1092. "group": "Success 200",
  1093. "type": "String",
  1094. "optional": false,
  1095. "field": "product.content",
  1096. "description": "<p>内容</p>"
  1097. },
  1098. {
  1099. "group": "Success 200",
  1100. "type": "String",
  1101. "optional": false,
  1102. "field": "product.price",
  1103. "description": "<p>显示价格</p>"
  1104. },
  1105. {
  1106. "group": "Success 200",
  1107. "type": "Number",
  1108. "optional": false,
  1109. "field": "product.pay_price",
  1110. "description": "<p>支付价格</p>"
  1111. }
  1112. ]
  1113. }
  1114. },
  1115. "filename": "/root/input/doc/apidoc.php",
  1116. "groupTitle": "Product"
  1117. },
  1118. {
  1119. "type": "get",
  1120. "url": "product/?l=api.writeFormId",
  1121. "title": "记录formid,用于发送通知 请再按钮的地方加上该接口请求",
  1122. "version": "1.0.0",
  1123. "name": "api_writeFormId",
  1124. "group": "Product",
  1125. "description": "<p>记录formid,用于发送通知</p>",
  1126. "parameter": {
  1127. "fields": {
  1128. "Parameter": [
  1129. {
  1130. "group": "Parameter",
  1131. "type": "String",
  1132. "optional": false,
  1133. "field": "signature",
  1134. "description": "<p>signature</p>"
  1135. },
  1136. {
  1137. "group": "Parameter",
  1138. "type": "String",
  1139. "optional": false,
  1140. "field": "product_id",
  1141. "description": "<p>产品id</p>"
  1142. }
  1143. ]
  1144. }
  1145. },
  1146. "filename": "/root/input/doc/apidoc.php",
  1147. "groupTitle": "Product"
  1148. },
  1149. {
  1150. "success": {
  1151. "fields": {
  1152. "Success 200": [
  1153. {
  1154. "group": "Success 200",
  1155. "optional": false,
  1156. "field": "varname1",
  1157. "description": "<p>No type.</p>"
  1158. },
  1159. {
  1160. "group": "Success 200",
  1161. "type": "String",
  1162. "optional": false,
  1163. "field": "varname2",
  1164. "description": "<p>With type.</p>"
  1165. }
  1166. ]
  1167. }
  1168. },
  1169. "type": "",
  1170. "url": "",
  1171. "version": "0.0.0",
  1172. "filename": "/root/input/doc/main.js",
  1173. "group": "_root_input_doc_main_js",
  1174. "groupTitle": "_root_input_doc_main_js",
  1175. "name": ""
  1176. }
  1177. ] });