[ { "type": "get", "url": "common", "title": "公共参数说明", "version": "1.0.0", "name": "common", "group": "Common", "description": "

介绍公共参数

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": false, "field": "json", "description": "

是否返回json格式的数据1为返回2为不返回

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "signature", "description": "

用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "pg", "description": "

用于分页传参,比如请求第二页数据,则加上该参数pg=2,没有分页和瀑布流不需要该参数

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Number", "optional": false, "field": "status", "description": "

状态,1为有效2为无效

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "msg", "description": "

请求的数据是否成功的提示

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "data", "description": "

如果status为1,data有值

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "page", "description": "

分页信息

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "page.total", "description": "

分页总数

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "page.current_page", "description": "

当前页

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "page.total_page", "description": "

总页数

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "page.next_page", "description": "

下一页

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "page.prev_page", "description": "

上一页

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "page.status", "description": "

是否有下一页数据,0为没有

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Common" }, { "type": "get", "url": "passport/?l=applet.bind", "title": "用户登录", "version": "1.0.0", "name": "applet_bind", "group": "Passport", "description": "

用户登录

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "code", "description": "

微信登录返回的code

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Number", "optional": false, "field": "vid", "description": "

微信id,请保存在本地

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "uid", "description": "

用户id,请保存在本地

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "signature", "description": "

用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Passport" }, { "type": "get", "url": "passport/?l=applet.bind_mobile", "title": "绑定手机号-验证码绑定", "version": "1.0.0", "name": "applet_bind_mobile", "group": "Passport", "description": "

绑定手机号-验证码绑定

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": false, "field": "uid", "description": "

用户id

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "mobile", "description": "

手机号

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "mcode", "description": "

验证码

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Number", "optional": false, "field": "uid", "description": "

用户id,请保存在本地

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "signature", "description": "

用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Passport" }, { "type": "get", "url": "passport/?l=applet.mobile", "title": "更新用户手机号-微信绑定", "version": "1.0.0", "name": "applet_mobile", "group": "Passport", "description": "

更新用户手机号-微信绑定

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "iv", "description": "

微信的加密参数

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "encryptedData", "description": "

微信的加密参数

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "vid", "description": "

微信id

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "uid", "description": "

用户id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Number", "optional": false, "field": "vid", "description": "

微信id,请保存在本地

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "uid", "description": "

用户id,请保存在本地

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "signature", "description": "

用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Passport" }, { "type": "get", "url": "passport/?l=applet.update", "title": "更新用户信息", "version": "1.0.0", "name": "applet_update", "group": "Passport", "description": "

更新用户信息

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "nickname", "description": "

用户昵称

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "avatarurl", "description": "

用户头像

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "iv", "description": "

微信的加密参数

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "encryptedData", "description": "

微信的加密参数

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "vid", "description": "

微信id

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "uid", "description": "

用户id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Number", "optional": false, "field": "vid", "description": "

微信id,请保存在本地

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "uid", "description": "

用户id,请保存在本地

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "signature", "description": "

用于登录后的uid验证,每次都要传入,请登录后将这个值保存在本地

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Passport" }, { "type": "get", "url": "passport/?l=reg.getMCode", "title": "获取手机验证码", "version": "1.0.0", "name": "reg_getMCode", "group": "Passport", "description": "

获取手机验证码

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "Number", "optional": false, "field": "mobile", "description": "

手机号

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "msg", "description": "

验证码已发送至您的手机,请注意查收,十分钟之内有效

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Passport" }, { "type": "get", "url": "product/?l=api.addAddress", "title": "添加收货地址", "version": "1.0.0", "name": "api_addAddress", "group": "Product", "description": "

添加收货地址

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

收货人姓名

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "

收货人地址

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "mobile", "description": "

收货人联系电话

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "data", "description": "

返回ok

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.addCarts", "title": "添加产品到购物车", "version": "1.0.0", "name": "api_addCarts", "group": "Product", "description": "

添加产品到购物车

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "product_id", "description": "

产品id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "num", "description": "

数量

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "data", "description": "

返回ok

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.buy", "title": "发起微信支付", "version": "1.0.0", "name": "api_buy", "group": "Product", "description": "

发起微信支付

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "product_id", "description": "

产品id,多个用逗号隔开

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "num", "description": "

产品数量,多个用逗号隔开

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

收货人姓名

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "

收货人地址

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "mobile", "description": "

收货人联系电话

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "invite_uid", "description": "

邀请人uid,scene参数中的uid

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Object[]", "optional": false, "field": "pay", "description": "

微信支付返回的数据

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "pay.time", "description": "

服务器时间戳

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "pay.nonce_str", "description": "

随机字符串

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "pay.prepay_id", "description": "

统一下单接口返回的 prepay_id 参数值,通过'prepay_id=' + prepay_id 拼装成package

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "pay.sign_type", "description": "

签名算法

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "pay.sign", "description": "

签名

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.carts", "title": "获取购物车列表", "version": "1.0.0", "name": "api_carts", "group": "Product", "description": "

获取购物车列表

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Object[]", "optional": false, "field": "carts", "description": "

购物车信息

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "carts.product", "description": "

产品信息

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "carts.num", "description": "

数量

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "address", "description": "

收货地址

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address.name", "description": "

收货人姓名

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address.address", "description": "

收货人地址

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address.mobile", "description": "

收货人联系电话

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.checkCode", "title": "根据兑换码获取产品信息", "version": "1.0.0", "name": "api_checkCode", "group": "Product", "description": "

根据兑换码获取产品信息

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "code", "description": "

兑换码

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Object[]", "optional": false, "field": "product", "description": "

产品信息

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.id", "description": "

产品id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.name", "description": "

名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.pic", "description": "

产品封面

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.focus", "description": "

产品轮播图 多个用逗号隔开

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.content", "description": "

内容

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.price", "description": "

显示价格

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "product.pay_price", "description": "

支付价格

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "address", "description": "

收货地址

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address.name", "description": "

收货人姓名

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address.address", "description": "

收货人地址

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "address.mobile", "description": "

收货人联系电话

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.code", "title": "提交兑换码", "version": "1.0.0", "name": "api_code", "group": "Product", "description": "

提交兑换码

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "product_id", "description": "

产品id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "code", "description": "

兑换码

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "name", "description": "

收货人姓名

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "address", "description": "

收货人地址

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "mobile", "description": "

收货人联系电话

" }, { "group": "Parameter", "type": "Number", "optional": false, "field": "invite_uid", "description": "

邀请人uid,scene参数中的uid

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.delCarts", "title": "从购物车删除产品", "version": "1.0.0", "name": "api_delCarts", "group": "Product", "description": "

从购物车删除产品

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "product_id", "description": "

产品id

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "data", "description": "

返回ok

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.home", "title": "获取首页数据", "version": "1.0.0", "name": "api_home", "group": "Product", "description": "

获取首页数据

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Number", "optional": false, "field": "uid", "description": "

用户id 所有Service接口中都有该项

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "config", "description": "

基本配置 所有Service接口中都有该项

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "config.name", "description": "

小程序名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "config.logo", "description": "

小程序logo

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "focus", "description": "

焦点图 暂时无用

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "focus.name", "description": "

名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "focus.pic", "description": "

图片

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "product", "description": "

产品列表

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.id", "description": "

产品id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.name", "description": "

名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.pic", "description": "

产品封面

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.focus", "description": "

产品轮播图 多个用逗号隔开

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.content", "description": "

内容

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.price", "description": "

显示价格

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "product.pay_price", "description": "

支付价格

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.order", "title": "我的订单", "version": "1.0.0", "name": "api_order", "group": "Product", "description": "

我的订单

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Object[]", "optional": false, "field": "order", "description": "

订单信息

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "order.name", "description": "

名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "order.order_id", "description": "

订单编号

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "order.del_status", "description": "

产品在线状态1为在线2为已下线

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.poster", "title": "生成海报", "version": "1.0.0", "name": "api_poster", "group": "Product", "description": "

生成海报

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "product_id", "description": "

产品id

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "path", "description": "

生成的二维码跳转的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。支付或者兑换使用。

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "String", "optional": false, "field": "pic", "description": "

直接返回海报图片

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.view", "title": "获取产品详情", "version": "1.0.0", "name": "api_view", "group": "Product", "description": "

获取产品详情

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "id", "description": "

产品id

" } ] } }, "success": { "fields": { "Success 200": [ { "group": "Success 200", "type": "Object[]", "optional": false, "field": "focus", "description": "

焦点图

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "focus.name", "description": "

名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "focus.pic", "description": "

图片

" }, { "group": "Success 200", "type": "Object[]", "optional": false, "field": "product", "description": "

产品信息

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.id", "description": "

产品id

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.name", "description": "

名称

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.pic", "description": "

产品封面

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.focus", "description": "

产品轮播图 多个用逗号隔开

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.content", "description": "

内容

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "product.price", "description": "

显示价格

" }, { "group": "Success 200", "type": "Number", "optional": false, "field": "product.pay_price", "description": "

支付价格

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "type": "get", "url": "product/?l=api.writeFormId", "title": "记录formid,用于发送通知 请再按钮的地方加上该接口请求", "version": "1.0.0", "name": "api_writeFormId", "group": "Product", "description": "

记录formid,用于发送通知

", "parameter": { "fields": { "Parameter": [ { "group": "Parameter", "type": "String", "optional": false, "field": "signature", "description": "

signature

" }, { "group": "Parameter", "type": "String", "optional": false, "field": "product_id", "description": "

产品id

" } ] } }, "filename": "/root/input/doc/apidoc.php", "groupTitle": "Product" }, { "success": { "fields": { "Success 200": [ { "group": "Success 200", "optional": false, "field": "varname1", "description": "

No type.

" }, { "group": "Success 200", "type": "String", "optional": false, "field": "varname2", "description": "

With type.

" } ] } }, "type": "", "url": "", "version": "0.0.0", "filename": "/root/input/doc/main.js", "group": "_root_input_doc_main_js", "groupTitle": "_root_input_doc_main_js", "name": "" } ]