api_data.js 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170
  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. }
  584. },
  585. "success": {
  586. "fields": {
  587. "Success 200": [
  588. {
  589. "group": "Success 200",
  590. "type": "Object[]",
  591. "optional": false,
  592. "field": "pay",
  593. "description": "<p>微信支付返回的数据</p>"
  594. },
  595. {
  596. "group": "Success 200",
  597. "type": "String",
  598. "optional": false,
  599. "field": "pay.time",
  600. "description": "<p>服务器时间戳</p>"
  601. },
  602. {
  603. "group": "Success 200",
  604. "type": "String",
  605. "optional": false,
  606. "field": "pay.nonce_str",
  607. "description": "<p>随机字符串</p>"
  608. },
  609. {
  610. "group": "Success 200",
  611. "type": "String",
  612. "optional": false,
  613. "field": "pay.prepay_id",
  614. "description": "<p>统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package</p>"
  615. },
  616. {
  617. "group": "Success 200",
  618. "type": "String",
  619. "optional": false,
  620. "field": "pay.sign_type",
  621. "description": "<p>签名算法</p>"
  622. },
  623. {
  624. "group": "Success 200",
  625. "type": "String",
  626. "optional": false,
  627. "field": "pay.sign",
  628. "description": "<p>签名</p>"
  629. }
  630. ]
  631. }
  632. },
  633. "filename": "/root/input/doc/apidoc.php",
  634. "groupTitle": "Product"
  635. },
  636. {
  637. "type": "get",
  638. "url": "product/?l=api.carts",
  639. "title": "获取购物车列表",
  640. "version": "1.0.0",
  641. "name": "api_buy",
  642. "group": "Product",
  643. "description": "<p>获取购物车列表</p>",
  644. "parameter": {
  645. "fields": {
  646. "Parameter": [
  647. {
  648. "group": "Parameter",
  649. "type": "String",
  650. "optional": false,
  651. "field": "signature",
  652. "description": "<p>signature</p>"
  653. }
  654. ]
  655. }
  656. },
  657. "success": {
  658. "fields": {
  659. "Success 200": [
  660. {
  661. "group": "Success 200",
  662. "type": "Object[]",
  663. "optional": false,
  664. "field": "carts",
  665. "description": "<p>购物车信息</p>"
  666. },
  667. {
  668. "group": "Success 200",
  669. "type": "String",
  670. "optional": false,
  671. "field": "carts.product",
  672. "description": "<p>产品信息</p>"
  673. },
  674. {
  675. "group": "Success 200",
  676. "type": "String",
  677. "optional": false,
  678. "field": "carts.num",
  679. "description": "<p>数量</p>"
  680. },
  681. {
  682. "group": "Success 200",
  683. "type": "Object[]",
  684. "optional": false,
  685. "field": "address",
  686. "description": "<p>收货地址</p>"
  687. },
  688. {
  689. "group": "Success 200",
  690. "type": "String",
  691. "optional": false,
  692. "field": "address.name",
  693. "description": "<p>收货人姓名</p>"
  694. },
  695. {
  696. "group": "Success 200",
  697. "type": "String",
  698. "optional": false,
  699. "field": "address.address",
  700. "description": "<p>收货人地址</p>"
  701. },
  702. {
  703. "group": "Success 200",
  704. "type": "String",
  705. "optional": false,
  706. "field": "address.mobile",
  707. "description": "<p>收货人联系电话</p>"
  708. }
  709. ]
  710. }
  711. },
  712. "filename": "/root/input/doc/apidoc.php",
  713. "groupTitle": "Product"
  714. },
  715. {
  716. "type": "get",
  717. "url": "product/?l=api.code",
  718. "title": "提交兑换码",
  719. "version": "1.0.0",
  720. "name": "api_code",
  721. "group": "Product",
  722. "description": "<p>提交兑换码</p>",
  723. "parameter": {
  724. "fields": {
  725. "Parameter": [
  726. {
  727. "group": "Parameter",
  728. "type": "String",
  729. "optional": false,
  730. "field": "signature",
  731. "description": "<p>signature</p>"
  732. },
  733. {
  734. "group": "Parameter",
  735. "type": "String",
  736. "optional": false,
  737. "field": "product_id",
  738. "description": "<p>产品id</p>"
  739. },
  740. {
  741. "group": "Parameter",
  742. "type": "String",
  743. "optional": false,
  744. "field": "code",
  745. "description": "<p>兑换码</p>"
  746. }
  747. ]
  748. }
  749. },
  750. "filename": "/root/input/doc/apidoc.php",
  751. "groupTitle": "Product"
  752. },
  753. {
  754. "type": "get",
  755. "url": "product/?l=api.home",
  756. "title": "获取首页数据",
  757. "version": "1.0.0",
  758. "name": "api_home",
  759. "group": "Product",
  760. "description": "<p>获取首页数据</p>",
  761. "parameter": {
  762. "fields": {
  763. "Parameter": [
  764. {
  765. "group": "Parameter",
  766. "type": "String",
  767. "optional": false,
  768. "field": "signature",
  769. "description": "<p>signature</p>"
  770. }
  771. ]
  772. }
  773. },
  774. "success": {
  775. "fields": {
  776. "Success 200": [
  777. {
  778. "group": "Success 200",
  779. "type": "Number",
  780. "optional": false,
  781. "field": "uid",
  782. "description": "<p>用户id 所有Service接口中都有该项</p>"
  783. },
  784. {
  785. "group": "Success 200",
  786. "type": "Object[]",
  787. "optional": false,
  788. "field": "config",
  789. "description": "<p>基本配置 所有Service接口中都有该项</p>"
  790. },
  791. {
  792. "group": "Success 200",
  793. "type": "String",
  794. "optional": false,
  795. "field": "config.name",
  796. "description": "<p>小程序名称</p>"
  797. },
  798. {
  799. "group": "Success 200",
  800. "type": "String",
  801. "optional": false,
  802. "field": "config.logo",
  803. "description": "<p>小程序logo</p>"
  804. },
  805. {
  806. "group": "Success 200",
  807. "type": "Object[]",
  808. "optional": false,
  809. "field": "focus",
  810. "description": "<p>焦点图 暂时无用</p>"
  811. },
  812. {
  813. "group": "Success 200",
  814. "type": "String",
  815. "optional": false,
  816. "field": "focus.name",
  817. "description": "<p>名称</p>"
  818. },
  819. {
  820. "group": "Success 200",
  821. "type": "String",
  822. "optional": false,
  823. "field": "focus.pic",
  824. "description": "<p>图片</p>"
  825. },
  826. {
  827. "group": "Success 200",
  828. "type": "Object[]",
  829. "optional": false,
  830. "field": "product",
  831. "description": "<p>产品列表</p>"
  832. },
  833. {
  834. "group": "Success 200",
  835. "type": "String",
  836. "optional": false,
  837. "field": "product.id",
  838. "description": "<p>产品id</p>"
  839. },
  840. {
  841. "group": "Success 200",
  842. "type": "String",
  843. "optional": false,
  844. "field": "product.name",
  845. "description": "<p>名称</p>"
  846. },
  847. {
  848. "group": "Success 200",
  849. "type": "String",
  850. "optional": false,
  851. "field": "product.pic",
  852. "description": "<p>产品封面</p>"
  853. },
  854. {
  855. "group": "Success 200",
  856. "type": "String",
  857. "optional": false,
  858. "field": "product.focus",
  859. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  860. },
  861. {
  862. "group": "Success 200",
  863. "type": "String",
  864. "optional": false,
  865. "field": "product.content",
  866. "description": "<p>内容</p>"
  867. },
  868. {
  869. "group": "Success 200",
  870. "type": "String",
  871. "optional": false,
  872. "field": "product.price",
  873. "description": "<p>显示价格</p>"
  874. },
  875. {
  876. "group": "Success 200",
  877. "type": "Number",
  878. "optional": false,
  879. "field": "product.pay_price",
  880. "description": "<p>支付价格</p>"
  881. }
  882. ]
  883. }
  884. },
  885. "filename": "/root/input/doc/apidoc.php",
  886. "groupTitle": "Product"
  887. },
  888. {
  889. "type": "get",
  890. "url": "product/?l=api.order",
  891. "title": "我的订单",
  892. "version": "1.0.0",
  893. "name": "api_order",
  894. "group": "Product",
  895. "description": "<p>我的订单</p>",
  896. "parameter": {
  897. "fields": {
  898. "Parameter": [
  899. {
  900. "group": "Parameter",
  901. "type": "String",
  902. "optional": false,
  903. "field": "signature",
  904. "description": "<p>signature</p>"
  905. }
  906. ]
  907. }
  908. },
  909. "success": {
  910. "fields": {
  911. "Success 200": [
  912. {
  913. "group": "Success 200",
  914. "type": "Object[]",
  915. "optional": false,
  916. "field": "order",
  917. "description": "<p>订单信息</p>"
  918. },
  919. {
  920. "group": "Success 200",
  921. "type": "String",
  922. "optional": false,
  923. "field": "order.name",
  924. "description": "<p>名称</p>"
  925. },
  926. {
  927. "group": "Success 200",
  928. "type": "String",
  929. "optional": false,
  930. "field": "order.order_id",
  931. "description": "<p>订单编号</p>"
  932. },
  933. {
  934. "group": "Success 200",
  935. "type": "String",
  936. "optional": false,
  937. "field": "order.del_status",
  938. "description": "<p>产品在线状态1为在线2为已下线</p>"
  939. }
  940. ]
  941. }
  942. },
  943. "filename": "/root/input/doc/apidoc.php",
  944. "groupTitle": "Product"
  945. },
  946. {
  947. "type": "get",
  948. "url": "product/?l=api.poster",
  949. "title": "生成海报",
  950. "version": "1.0.0",
  951. "name": "api_poster",
  952. "group": "Product",
  953. "description": "<p>生成海报</p>",
  954. "parameter": {
  955. "fields": {
  956. "Parameter": [
  957. {
  958. "group": "Parameter",
  959. "type": "String",
  960. "optional": false,
  961. "field": "signature",
  962. "description": "<p>signature</p>"
  963. },
  964. {
  965. "group": "Parameter",
  966. "type": "String",
  967. "optional": false,
  968. "field": "product_id",
  969. "description": "<p>产品id</p>"
  970. },
  971. {
  972. "group": "Parameter",
  973. "type": "String",
  974. "optional": false,
  975. "field": "path",
  976. "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>"
  977. }
  978. ]
  979. }
  980. },
  981. "success": {
  982. "fields": {
  983. "Success 200": [
  984. {
  985. "group": "Success 200",
  986. "type": "String",
  987. "optional": false,
  988. "field": "pic",
  989. "description": "<p>直接返回海报图片</p>"
  990. }
  991. ]
  992. }
  993. },
  994. "filename": "/root/input/doc/apidoc.php",
  995. "groupTitle": "Product"
  996. },
  997. {
  998. "type": "get",
  999. "url": "product/?l=api.view",
  1000. "title": "获取产品详情",
  1001. "version": "1.0.0",
  1002. "name": "api_view",
  1003. "group": "Product",
  1004. "description": "<p>获取产品详情</p>",
  1005. "parameter": {
  1006. "fields": {
  1007. "Parameter": [
  1008. {
  1009. "group": "Parameter",
  1010. "type": "String",
  1011. "optional": false,
  1012. "field": "signature",
  1013. "description": "<p>signature</p>"
  1014. },
  1015. {
  1016. "group": "Parameter",
  1017. "type": "String",
  1018. "optional": false,
  1019. "field": "id",
  1020. "description": "<p>产品id</p>"
  1021. }
  1022. ]
  1023. }
  1024. },
  1025. "success": {
  1026. "fields": {
  1027. "Success 200": [
  1028. {
  1029. "group": "Success 200",
  1030. "type": "Object[]",
  1031. "optional": false,
  1032. "field": "focus",
  1033. "description": "<p>焦点图</p>"
  1034. },
  1035. {
  1036. "group": "Success 200",
  1037. "type": "String",
  1038. "optional": false,
  1039. "field": "focus.name",
  1040. "description": "<p>名称</p>"
  1041. },
  1042. {
  1043. "group": "Success 200",
  1044. "type": "String",
  1045. "optional": false,
  1046. "field": "focus.pic",
  1047. "description": "<p>图片</p>"
  1048. },
  1049. {
  1050. "group": "Success 200",
  1051. "type": "Object[]",
  1052. "optional": false,
  1053. "field": "product",
  1054. "description": "<p>产品信息</p>"
  1055. },
  1056. {
  1057. "group": "Success 200",
  1058. "type": "String",
  1059. "optional": false,
  1060. "field": "product.id",
  1061. "description": "<p>产品id</p>"
  1062. },
  1063. {
  1064. "group": "Success 200",
  1065. "type": "String",
  1066. "optional": false,
  1067. "field": "product.name",
  1068. "description": "<p>名称</p>"
  1069. },
  1070. {
  1071. "group": "Success 200",
  1072. "type": "String",
  1073. "optional": false,
  1074. "field": "product.pic",
  1075. "description": "<p>产品封面</p>"
  1076. },
  1077. {
  1078. "group": "Success 200",
  1079. "type": "String",
  1080. "optional": false,
  1081. "field": "product.focus",
  1082. "description": "<p>产品轮播图 多个用逗号隔开</p>"
  1083. },
  1084. {
  1085. "group": "Success 200",
  1086. "type": "String",
  1087. "optional": false,
  1088. "field": "product.content",
  1089. "description": "<p>内容</p>"
  1090. },
  1091. {
  1092. "group": "Success 200",
  1093. "type": "String",
  1094. "optional": false,
  1095. "field": "product.price",
  1096. "description": "<p>显示价格</p>"
  1097. },
  1098. {
  1099. "group": "Success 200",
  1100. "type": "Number",
  1101. "optional": false,
  1102. "field": "product.pay_price",
  1103. "description": "<p>支付价格</p>"
  1104. }
  1105. ]
  1106. }
  1107. },
  1108. "filename": "/root/input/doc/apidoc.php",
  1109. "groupTitle": "Product"
  1110. },
  1111. {
  1112. "type": "get",
  1113. "url": "product/?l=api.writeFormId",
  1114. "title": "记录formid,用于发送通知 请再按钮的地方加上该接口请求",
  1115. "version": "1.0.0",
  1116. "name": "api_writeFormId",
  1117. "group": "Product",
  1118. "description": "<p>记录formid,用于发送通知</p>",
  1119. "parameter": {
  1120. "fields": {
  1121. "Parameter": [
  1122. {
  1123. "group": "Parameter",
  1124. "type": "String",
  1125. "optional": false,
  1126. "field": "signature",
  1127. "description": "<p>signature</p>"
  1128. },
  1129. {
  1130. "group": "Parameter",
  1131. "type": "String",
  1132. "optional": false,
  1133. "field": "product_id",
  1134. "description": "<p>产品id</p>"
  1135. }
  1136. ]
  1137. }
  1138. },
  1139. "filename": "/root/input/doc/apidoc.php",
  1140. "groupTitle": "Product"
  1141. },
  1142. {
  1143. "success": {
  1144. "fields": {
  1145. "Success 200": [
  1146. {
  1147. "group": "Success 200",
  1148. "optional": false,
  1149. "field": "varname1",
  1150. "description": "<p>No type.</p>"
  1151. },
  1152. {
  1153. "group": "Success 200",
  1154. "type": "String",
  1155. "optional": false,
  1156. "field": "varname2",
  1157. "description": "<p>With type.</p>"
  1158. }
  1159. ]
  1160. }
  1161. },
  1162. "type": "",
  1163. "url": "",
  1164. "version": "0.0.0",
  1165. "filename": "/root/input/doc/main.js",
  1166. "group": "_root_input_doc_main_js",
  1167. "groupTitle": "_root_input_doc_main_js",
  1168. "name": ""
  1169. }
  1170. ] });