api_data.js 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398
  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. "group": "Parameter",
  591. "type": "String",
  592. "optional": false,
  593. "field": "name",
  594. "description": "<p>收货人姓名</p>"
  595. },
  596. {
  597. "group": "Parameter",
  598. "type": "String",
  599. "optional": false,
  600. "field": "address",
  601. "description": "<p>收货人地址</p>"
  602. },
  603. {
  604. "group": "Parameter",
  605. "type": "String",
  606. "optional": false,
  607. "field": "mobile",
  608. "description": "<p>收货人联系电话</p>"
  609. },
  610. {
  611. "group": "Parameter",
  612. "type": "Number",
  613. "optional": false,
  614. "field": "invite_uid",
  615. "description": "<p>邀请人uid,scene参数中的uid</p>"
  616. }
  617. ]
  618. }
  619. },
  620. "success": {
  621. "fields": {
  622. "Success 200": [
  623. {
  624. "group": "Success 200",
  625. "type": "Object[]",
  626. "optional": false,
  627. "field": "pay",
  628. "description": "<p>微信支付返回的数据</p>"
  629. },
  630. {
  631. "group": "Success 200",
  632. "type": "String",
  633. "optional": false,
  634. "field": "pay.time",
  635. "description": "<p>服务器时间戳</p>"
  636. },
  637. {
  638. "group": "Success 200",
  639. "type": "String",
  640. "optional": false,
  641. "field": "pay.nonce_str",
  642. "description": "<p>随机字符串</p>"
  643. },
  644. {
  645. "group": "Success 200",
  646. "type": "String",
  647. "optional": false,
  648. "field": "pay.prepay_id",
  649. "description": "<p>统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package</p>"
  650. },
  651. {
  652. "group": "Success 200",
  653. "type": "String",
  654. "optional": false,
  655. "field": "pay.sign_type",
  656. "description": "<p>签名算法</p>"
  657. },
  658. {
  659. "group": "Success 200",
  660. "type": "String",
  661. "optional": false,
  662. "field": "pay.sign",
  663. "description": "<p>签名</p>"
  664. }
  665. ]
  666. }
  667. },
  668. "filename": "/root/input/doc/apidoc.php",
  669. "groupTitle": "Product"
  670. },
  671. {
  672. "type": "get",
  673. "url": "product/?l=api.carts",
  674. "title": "获取购物车列表",
  675. "version": "1.0.0",
  676. "name": "api_carts",
  677. "group": "Product",
  678. "description": "<p>获取购物车列表</p>",
  679. "parameter": {
  680. "fields": {
  681. "Parameter": [
  682. {
  683. "group": "Parameter",
  684. "type": "String",
  685. "optional": false,
  686. "field": "signature",
  687. "description": "<p>signature</p>"
  688. }
  689. ]
  690. }
  691. },
  692. "success": {
  693. "fields": {
  694. "Success 200": [
  695. {
  696. "group": "Success 200",
  697. "type": "Object[]",
  698. "optional": false,
  699. "field": "carts",
  700. "description": "<p>购物车信息</p>"
  701. },
  702. {
  703. "group": "Success 200",
  704. "type": "String",
  705. "optional": false,
  706. "field": "carts.product",
  707. "description": "<p>产品信息</p>"
  708. },
  709. {
  710. "group": "Success 200",
  711. "type": "String",
  712. "optional": false,
  713. "field": "carts.num",
  714. "description": "<p>数量</p>"
  715. },
  716. {
  717. "group": "Success 200",
  718. "type": "Object[]",
  719. "optional": false,
  720. "field": "address",
  721. "description": "<p>收货地址</p>"
  722. },
  723. {
  724. "group": "Success 200",
  725. "type": "String",
  726. "optional": false,
  727. "field": "address.name",
  728. "description": "<p>收货人姓名</p>"
  729. },
  730. {
  731. "group": "Success 200",
  732. "type": "String",
  733. "optional": false,
  734. "field": "address.address",
  735. "description": "<p>收货人地址</p>"
  736. },
  737. {
  738. "group": "Success 200",
  739. "type": "String",
  740. "optional": false,
  741. "field": "address.mobile",
  742. "description": "<p>收货人联系电话</p>"
  743. }
  744. ]
  745. }
  746. },
  747. "filename": "/root/input/doc/apidoc.php",
  748. "groupTitle": "Product"
  749. },
  750. {
  751. "type": "get",
  752. "url": "product/?l=api.checkCode",
  753. "title": "根据兑换码获取产品信息",
  754. "version": "1.0.0",
  755. "name": "api_checkCode",
  756. "group": "Product",
  757. "description": "<p>根据兑换码获取产品信息</p>",
  758. "parameter": {
  759. "fields": {
  760. "Parameter": [
  761. {
  762. "group": "Parameter",
  763. "type": "String",
  764. "optional": false,
  765. "field": "signature",
  766. "description": "<p>signature</p>"
  767. },
  768. {
  769. "group": "Parameter",
  770. "type": "String",
  771. "optional": false,
  772. "field": "code",
  773. "description": "<p>兑换码</p>"
  774. }
  775. ]
  776. }
  777. },
  778. "success": {
  779. "fields": {
  780. "Success 200": [
  781. {
  782. "group": "Success 200",
  783. "type": "Object[]",
  784. "optional": false,
  785. "field": "product",
  786. "description": "<p>产品信息</p>"
  787. },
  788. {
  789. "group": "Success 200",
  790. "type": "String",
  791. "optional": false,
  792. "field": "product.id",
  793. "description": "<p>产品id</p>"
  794. },
  795. {
  796. "group": "Success 200",
  797. "type": "String",
  798. "optional": false,
  799. "field": "product.name",
  800. "description": "<p>名称</p>"
  801. },
  802. {
  803. "group": "Success 200",
  804. "type": "String",
  805. "optional": false,
  806. "field": "product.pic",
  807. "description": "<p>产品封面</p>"
  808. },
  809. {
  810. "group": "Success 200",
  811. "type": "String",
  812. "optional": false,
  813. "field": "product.focus",
  814. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  815. },
  816. {
  817. "group": "Success 200",
  818. "type": "String",
  819. "optional": false,
  820. "field": "product.content",
  821. "description": "<p>内容</p>"
  822. },
  823. {
  824. "group": "Success 200",
  825. "type": "String",
  826. "optional": false,
  827. "field": "product.price",
  828. "description": "<p>显示价格</p>"
  829. },
  830. {
  831. "group": "Success 200",
  832. "type": "Number",
  833. "optional": false,
  834. "field": "product.pay_price",
  835. "description": "<p>支付价格</p>"
  836. },
  837. {
  838. "group": "Success 200",
  839. "type": "Object[]",
  840. "optional": false,
  841. "field": "address",
  842. "description": "<p>收货地址</p>"
  843. },
  844. {
  845. "group": "Success 200",
  846. "type": "String",
  847. "optional": false,
  848. "field": "address.name",
  849. "description": "<p>收货人姓名</p>"
  850. },
  851. {
  852. "group": "Success 200",
  853. "type": "String",
  854. "optional": false,
  855. "field": "address.address",
  856. "description": "<p>收货人地址</p>"
  857. },
  858. {
  859. "group": "Success 200",
  860. "type": "String",
  861. "optional": false,
  862. "field": "address.mobile",
  863. "description": "<p>收货人联系电话</p>"
  864. }
  865. ]
  866. }
  867. },
  868. "filename": "/root/input/doc/apidoc.php",
  869. "groupTitle": "Product"
  870. },
  871. {
  872. "type": "get",
  873. "url": "product/?l=api.code",
  874. "title": "提交兑换码",
  875. "version": "1.0.0",
  876. "name": "api_code",
  877. "group": "Product",
  878. "description": "<p>提交兑换码</p>",
  879. "parameter": {
  880. "fields": {
  881. "Parameter": [
  882. {
  883. "group": "Parameter",
  884. "type": "String",
  885. "optional": false,
  886. "field": "signature",
  887. "description": "<p>signature</p>"
  888. },
  889. {
  890. "group": "Parameter",
  891. "type": "String",
  892. "optional": false,
  893. "field": "product_id",
  894. "description": "<p>产品id</p>"
  895. },
  896. {
  897. "group": "Parameter",
  898. "type": "String",
  899. "optional": false,
  900. "field": "code",
  901. "description": "<p>兑换码</p>"
  902. },
  903. {
  904. "group": "Parameter",
  905. "type": "String",
  906. "optional": false,
  907. "field": "name",
  908. "description": "<p>收货人姓名</p>"
  909. },
  910. {
  911. "group": "Parameter",
  912. "type": "String",
  913. "optional": false,
  914. "field": "address",
  915. "description": "<p>收货人地址</p>"
  916. },
  917. {
  918. "group": "Parameter",
  919. "type": "String",
  920. "optional": false,
  921. "field": "mobile",
  922. "description": "<p>收货人联系电话</p>"
  923. },
  924. {
  925. "group": "Parameter",
  926. "type": "Number",
  927. "optional": false,
  928. "field": "invite_uid",
  929. "description": "<p>邀请人uid,scene参数中的uid</p>"
  930. }
  931. ]
  932. }
  933. },
  934. "filename": "/root/input/doc/apidoc.php",
  935. "groupTitle": "Product"
  936. },
  937. {
  938. "type": "get",
  939. "url": "product/?l=api.delCarts",
  940. "title": "从购物车删除产品",
  941. "version": "1.0.0",
  942. "name": "api_delCarts",
  943. "group": "Product",
  944. "description": "<p>从购物车删除产品</p>",
  945. "parameter": {
  946. "fields": {
  947. "Parameter": [
  948. {
  949. "group": "Parameter",
  950. "type": "String",
  951. "optional": false,
  952. "field": "signature",
  953. "description": "<p>signature</p>"
  954. },
  955. {
  956. "group": "Parameter",
  957. "type": "String",
  958. "optional": false,
  959. "field": "product_id",
  960. "description": "<p>产品id</p>"
  961. }
  962. ]
  963. }
  964. },
  965. "success": {
  966. "fields": {
  967. "Success 200": [
  968. {
  969. "group": "Success 200",
  970. "type": "String",
  971. "optional": false,
  972. "field": "data",
  973. "description": "<p>返回ok</p>"
  974. }
  975. ]
  976. }
  977. },
  978. "filename": "/root/input/doc/apidoc.php",
  979. "groupTitle": "Product"
  980. },
  981. {
  982. "type": "get",
  983. "url": "product/?l=api.home",
  984. "title": "获取首页数据",
  985. "version": "1.0.0",
  986. "name": "api_home",
  987. "group": "Product",
  988. "description": "<p>获取首页数据</p>",
  989. "parameter": {
  990. "fields": {
  991. "Parameter": [
  992. {
  993. "group": "Parameter",
  994. "type": "String",
  995. "optional": false,
  996. "field": "signature",
  997. "description": "<p>signature</p>"
  998. }
  999. ]
  1000. }
  1001. },
  1002. "success": {
  1003. "fields": {
  1004. "Success 200": [
  1005. {
  1006. "group": "Success 200",
  1007. "type": "Number",
  1008. "optional": false,
  1009. "field": "uid",
  1010. "description": "<p>用户id 所有Service接口中都有该项</p>"
  1011. },
  1012. {
  1013. "group": "Success 200",
  1014. "type": "Object[]",
  1015. "optional": false,
  1016. "field": "config",
  1017. "description": "<p>基本配置 所有Service接口中都有该项</p>"
  1018. },
  1019. {
  1020. "group": "Success 200",
  1021. "type": "String",
  1022. "optional": false,
  1023. "field": "config.name",
  1024. "description": "<p>小程序名称</p>"
  1025. },
  1026. {
  1027. "group": "Success 200",
  1028. "type": "String",
  1029. "optional": false,
  1030. "field": "config.logo",
  1031. "description": "<p>小程序logo</p>"
  1032. },
  1033. {
  1034. "group": "Success 200",
  1035. "type": "Object[]",
  1036. "optional": false,
  1037. "field": "focus",
  1038. "description": "<p>焦点图 暂时无用</p>"
  1039. },
  1040. {
  1041. "group": "Success 200",
  1042. "type": "String",
  1043. "optional": false,
  1044. "field": "focus.name",
  1045. "description": "<p>名称</p>"
  1046. },
  1047. {
  1048. "group": "Success 200",
  1049. "type": "String",
  1050. "optional": false,
  1051. "field": "focus.pic",
  1052. "description": "<p>图片</p>"
  1053. },
  1054. {
  1055. "group": "Success 200",
  1056. "type": "Object[]",
  1057. "optional": false,
  1058. "field": "product",
  1059. "description": "<p>产品列表</p>"
  1060. },
  1061. {
  1062. "group": "Success 200",
  1063. "type": "String",
  1064. "optional": false,
  1065. "field": "product.id",
  1066. "description": "<p>产品id</p>"
  1067. },
  1068. {
  1069. "group": "Success 200",
  1070. "type": "String",
  1071. "optional": false,
  1072. "field": "product.name",
  1073. "description": "<p>名称</p>"
  1074. },
  1075. {
  1076. "group": "Success 200",
  1077. "type": "String",
  1078. "optional": false,
  1079. "field": "product.pic",
  1080. "description": "<p>产品封面</p>"
  1081. },
  1082. {
  1083. "group": "Success 200",
  1084. "type": "String",
  1085. "optional": false,
  1086. "field": "product.focus",
  1087. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  1088. },
  1089. {
  1090. "group": "Success 200",
  1091. "type": "String",
  1092. "optional": false,
  1093. "field": "product.content",
  1094. "description": "<p>内容</p>"
  1095. },
  1096. {
  1097. "group": "Success 200",
  1098. "type": "String",
  1099. "optional": false,
  1100. "field": "product.price",
  1101. "description": "<p>显示价格</p>"
  1102. },
  1103. {
  1104. "group": "Success 200",
  1105. "type": "Number",
  1106. "optional": false,
  1107. "field": "product.pay_price",
  1108. "description": "<p>支付价格</p>"
  1109. }
  1110. ]
  1111. }
  1112. },
  1113. "filename": "/root/input/doc/apidoc.php",
  1114. "groupTitle": "Product"
  1115. },
  1116. {
  1117. "type": "get",
  1118. "url": "product/?l=api.order",
  1119. "title": "我的订单",
  1120. "version": "1.0.0",
  1121. "name": "api_order",
  1122. "group": "Product",
  1123. "description": "<p>我的订单</p>",
  1124. "parameter": {
  1125. "fields": {
  1126. "Parameter": [
  1127. {
  1128. "group": "Parameter",
  1129. "type": "String",
  1130. "optional": false,
  1131. "field": "signature",
  1132. "description": "<p>signature</p>"
  1133. }
  1134. ]
  1135. }
  1136. },
  1137. "success": {
  1138. "fields": {
  1139. "Success 200": [
  1140. {
  1141. "group": "Success 200",
  1142. "type": "Object[]",
  1143. "optional": false,
  1144. "field": "order",
  1145. "description": "<p>订单信息</p>"
  1146. },
  1147. {
  1148. "group": "Success 200",
  1149. "type": "String",
  1150. "optional": false,
  1151. "field": "order.name",
  1152. "description": "<p>名称</p>"
  1153. },
  1154. {
  1155. "group": "Success 200",
  1156. "type": "String",
  1157. "optional": false,
  1158. "field": "order.order_id",
  1159. "description": "<p>订单编号</p>"
  1160. },
  1161. {
  1162. "group": "Success 200",
  1163. "type": "String",
  1164. "optional": false,
  1165. "field": "order.del_status",
  1166. "description": "<p>产品在线状态1为在线2为已下线</p>"
  1167. }
  1168. ]
  1169. }
  1170. },
  1171. "filename": "/root/input/doc/apidoc.php",
  1172. "groupTitle": "Product"
  1173. },
  1174. {
  1175. "type": "get",
  1176. "url": "product/?l=api.poster",
  1177. "title": "生成海报",
  1178. "version": "1.0.0",
  1179. "name": "api_poster",
  1180. "group": "Product",
  1181. "description": "<p>生成海报</p>",
  1182. "parameter": {
  1183. "fields": {
  1184. "Parameter": [
  1185. {
  1186. "group": "Parameter",
  1187. "type": "String",
  1188. "optional": false,
  1189. "field": "signature",
  1190. "description": "<p>signature</p>"
  1191. },
  1192. {
  1193. "group": "Parameter",
  1194. "type": "String",
  1195. "optional": false,
  1196. "field": "product_id",
  1197. "description": "<p>产品id</p>"
  1198. },
  1199. {
  1200. "group": "Parameter",
  1201. "type": "String",
  1202. "optional": false,
  1203. "field": "path",
  1204. "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];如果有该参数,请直接跳转到产品详情页。并且请本地记录下uid。支付或者兑换使用。</p>"
  1205. }
  1206. ]
  1207. }
  1208. },
  1209. "success": {
  1210. "fields": {
  1211. "Success 200": [
  1212. {
  1213. "group": "Success 200",
  1214. "type": "String",
  1215. "optional": false,
  1216. "field": "pic",
  1217. "description": "<p>直接返回海报图片</p>"
  1218. }
  1219. ]
  1220. }
  1221. },
  1222. "filename": "/root/input/doc/apidoc.php",
  1223. "groupTitle": "Product"
  1224. },
  1225. {
  1226. "type": "get",
  1227. "url": "product/?l=api.view",
  1228. "title": "获取产品详情",
  1229. "version": "1.0.0",
  1230. "name": "api_view",
  1231. "group": "Product",
  1232. "description": "<p>获取产品详情</p>",
  1233. "parameter": {
  1234. "fields": {
  1235. "Parameter": [
  1236. {
  1237. "group": "Parameter",
  1238. "type": "String",
  1239. "optional": false,
  1240. "field": "signature",
  1241. "description": "<p>signature</p>"
  1242. },
  1243. {
  1244. "group": "Parameter",
  1245. "type": "String",
  1246. "optional": false,
  1247. "field": "id",
  1248. "description": "<p>产品id</p>"
  1249. }
  1250. ]
  1251. }
  1252. },
  1253. "success": {
  1254. "fields": {
  1255. "Success 200": [
  1256. {
  1257. "group": "Success 200",
  1258. "type": "Object[]",
  1259. "optional": false,
  1260. "field": "focus",
  1261. "description": "<p>焦点图</p>"
  1262. },
  1263. {
  1264. "group": "Success 200",
  1265. "type": "String",
  1266. "optional": false,
  1267. "field": "focus.name",
  1268. "description": "<p>名称</p>"
  1269. },
  1270. {
  1271. "group": "Success 200",
  1272. "type": "String",
  1273. "optional": false,
  1274. "field": "focus.pic",
  1275. "description": "<p>图片</p>"
  1276. },
  1277. {
  1278. "group": "Success 200",
  1279. "type": "Object[]",
  1280. "optional": false,
  1281. "field": "product",
  1282. "description": "<p>产品信息</p>"
  1283. },
  1284. {
  1285. "group": "Success 200",
  1286. "type": "String",
  1287. "optional": false,
  1288. "field": "product.id",
  1289. "description": "<p>产品id</p>"
  1290. },
  1291. {
  1292. "group": "Success 200",
  1293. "type": "String",
  1294. "optional": false,
  1295. "field": "product.name",
  1296. "description": "<p>名称</p>"
  1297. },
  1298. {
  1299. "group": "Success 200",
  1300. "type": "String",
  1301. "optional": false,
  1302. "field": "product.pic",
  1303. "description": "<p>产品封面</p>"
  1304. },
  1305. {
  1306. "group": "Success 200",
  1307. "type": "String",
  1308. "optional": false,
  1309. "field": "product.focus",
  1310. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  1311. },
  1312. {
  1313. "group": "Success 200",
  1314. "type": "String",
  1315. "optional": false,
  1316. "field": "product.content",
  1317. "description": "<p>内容</p>"
  1318. },
  1319. {
  1320. "group": "Success 200",
  1321. "type": "String",
  1322. "optional": false,
  1323. "field": "product.price",
  1324. "description": "<p>显示价格</p>"
  1325. },
  1326. {
  1327. "group": "Success 200",
  1328. "type": "Number",
  1329. "optional": false,
  1330. "field": "product.pay_price",
  1331. "description": "<p>支付价格</p>"
  1332. }
  1333. ]
  1334. }
  1335. },
  1336. "filename": "/root/input/doc/apidoc.php",
  1337. "groupTitle": "Product"
  1338. },
  1339. {
  1340. "type": "get",
  1341. "url": "product/?l=api.writeFormId",
  1342. "title": "记录formid,用于发送通知 请再按钮的地方加上该接口请求",
  1343. "version": "1.0.0",
  1344. "name": "api_writeFormId",
  1345. "group": "Product",
  1346. "description": "<p>记录formid,用于发送通知</p>",
  1347. "parameter": {
  1348. "fields": {
  1349. "Parameter": [
  1350. {
  1351. "group": "Parameter",
  1352. "type": "String",
  1353. "optional": false,
  1354. "field": "signature",
  1355. "description": "<p>signature</p>"
  1356. },
  1357. {
  1358. "group": "Parameter",
  1359. "type": "String",
  1360. "optional": false,
  1361. "field": "product_id",
  1362. "description": "<p>产品id</p>"
  1363. }
  1364. ]
  1365. }
  1366. },
  1367. "filename": "/root/input/doc/apidoc.php",
  1368. "groupTitle": "Product"
  1369. },
  1370. {
  1371. "success": {
  1372. "fields": {
  1373. "Success 200": [
  1374. {
  1375. "group": "Success 200",
  1376. "optional": false,
  1377. "field": "varname1",
  1378. "description": "<p>No type.</p>"
  1379. },
  1380. {
  1381. "group": "Success 200",
  1382. "type": "String",
  1383. "optional": false,
  1384. "field": "varname2",
  1385. "description": "<p>With type.</p>"
  1386. }
  1387. ]
  1388. }
  1389. },
  1390. "type": "",
  1391. "url": "",
  1392. "version": "0.0.0",
  1393. "filename": "/root/input/doc/main.js",
  1394. "group": "_root_input_doc_main_js",
  1395. "groupTitle": "_root_input_doc_main_js",
  1396. "name": ""
  1397. }
  1398. ] });