EggPlanet
/
egg_app
3
0
フォーク 0
コード 課題 0 プルリクエスト 0 リリース 0 Wiki アクティビティ
蛋蛋星球-客户端
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。
102 コミット
1 ブランチ
6.5 MiB
 
 
 
 
 
 
ツリー: a8a8cf607b
ブランチ タグ
${ item.name }
ブランチ ${ searchTerm } を作成
'a8a8cf607b' から
${ noResults }
egg_app/docs/swagger.yaml

727 行
18 KiB
Raw Blame 履歴 

  1. basePath: /api/v1

  2. definitions:

  3.   applet_app_md.Paginate:

  4.     properties:

  5.       limit:

  6.         description: 每页大小

  7.         type: integer

  8.       page:

  9.         description: 页数

  10.         type: integer

  11.       total:

  12.         description: 总数据量

  13.         type: integer

  14.     type: object

  15.   md.EggEnergyDetailReq:

  16.     properties:

  17.       asc:

  18.         description: 1.升序 2.倒序

  19.         type: string

  20.       direction:

  21.         description: 类型 1.收入 2.支出 全部则传空

  22.         type: string

  23.       kind:

  24.         description: 类型：1. 个人蛋蛋能量 2.团队蛋蛋能量

  25.         type: string

  26.       limit:

  27.         description: 每页大小

  28.         type: integer

  29.       page:

  30.         description: 页数

  31.         type: integer

  32.       type:

  33.         description: 变动类型 全部则传空

  34.         type: string

  35.     type: object

  36.   md.EggEnergyDetailResp:

  37.     properties:

  38.       list:

  39.         description: 流水数据

  40.         items:

  41.           additionalProperties:

  42.             type: string

  43.           type: object

  44.         type: array

  45.       paginate:

  46.         allOf:

  47.         - $ref: '#/definitions/applet_app_md.Paginate'

  48.         description: 分页信息

  49.       person_egg_energy:

  50.         description: 个人蛋蛋能量

  51.         type: string

  52.       team_egg_energy:

  53.         description: 团队蛋蛋能量

  54.         type: string

  55.       total_egg_energy:

  56.         description: 总蛋蛋能量

  57.         type: string

  58.       total_egg_energy_price:

  59.         description: 蛋蛋能量总价

  60.         type: string

  61.       transfer_type_list:

  62.         allOf:

  63.         - $ref: '#/definitions/md.TransferTypeList'

  64.         description: 转账类型列表

  65.     type: object

  66.   md.EggPointDetailsReq:

  67.     properties:

  68.       asc:

  69.         description: 1.升序 2.倒序

  70.         type: string

  71.       direction:

  72.         description: 类型 1.收入 2.支出 全部则传空

  73.         type: string

  74.       kind:

  75.         description: 类型：1. 个人蛋蛋积分 2.团队蛋蛋积分

  76.         type: string

  77.       limit:

  78.         description: 每页大小

  79.         type: integer

  80.       page:

  81.         description: 页数

  82.         type: integer

  83.       type:

  84.         description: 变动类型 全部则传空

  85.         type: string

  86.     type: object

  87.   md.EggPointDetailsResp:

  88.     properties:

  89.       list:

  90.         description: 流水数据

  91.         items:

  92.           additionalProperties:

  93.             type: string

  94.           type: object

  95.         type: array

  96.       paginate:

  97.         allOf:

  98.         - $ref: '#/definitions/applet_app_md.Paginate'

  99.         description: 分页信息

  100.       person_egg_points:

  101.         description: 个人蛋蛋积分

  102.         type: string

  103.       team_egg_points:

  104.         description: 团队蛋蛋积分

  105.         type: string

  106.       total_egg_points:

  107.         description: 总蛋蛋积分

  108.         type: string

  109.       total_egg_points_amount:

  110.         description: 蛋蛋积分余额

  111.         type: string

  112.       transfer_type_list:

  113.         allOf:

  114.         - $ref: '#/definitions/md.TransferTypeList'

  115.         description: 转账类型列表

  116.     type: object

  117.   md.HomePageResp:

  118.     properties:

  119.       egg_energy_now_price:

  120.         description: 蛋蛋能量当前价格

  121.         type: string

  122.       initial_price:

  123.         description: 蛋蛋能量初始价格

  124.         type: string

  125.       is_rises:

  126.         description: 是否涨价

  127.         type: boolean

  128.       is_sign:

  129.         description: 是否完成签到

  130.         type: boolean

  131.       nick_name:

  132.         description: 用户名称

  133.         type: string

  134.       now_basal_rate:

  135.         description: 当前基础速率/小时

  136.         type: string

  137.       now_team_rate:

  138.         description: 当前团队速率/小时

  139.         type: string

  140.       rises:

  141.         description: 涨/跌价百分比

  142.         type: string

  143.       sign_end_time:

  144.         description: 签到截止时间

  145.         type: string

  146.       sign_reward_egg_energy:

  147.         description: 签到奖励蛋蛋能量/秒

  148.         type: string

  149.       total_active_points:

  150.         description: 总活跃积分

  151.         type: string

  152.       total_egg_energy:

  153.         description: 总蛋蛋能量

  154.         type: string

  155.       user_count:

  156.         description: 当前用户数量

  157.         type: integer

  158.     type: object

  159.   md.HomePageWatchAdRuleResp:

  160.     properties:

  161.       each_round_hour:

  162.         description: 每一轮X个小时

  163.         type: string

  164.       interval_minutes:

  165.         description: 间隔X秒

  166.         type: string

  167.       reward_total_num:

  168.         description: 一共X个奖励视屏

  169.         type: string

  170.       reward_value:

  171.         description: 奖励X个活跃积分

  172.         type: string

  173.     type: object

  174.   md.IntegralList:

  175.     properties:

  176.       expend_list:

  177.         description: 支出类型列表

  178.         items:

  179.           $ref: '#/definitions/md.TransferTypeNode'

  180.         type: array

  181.       income_list:

  182.         description: 收入类型列表

  183.         items:

  184.           $ref: '#/definitions/md.TransferTypeNode'

  185.         type: array

  186.     type: object

  187.   md.IsCanGetRedPackageResp:

  188.     properties:

  189.       is_can_get_red_package:

  190.         type: boolean

  191.     type: object

  192.   md.IsCanSignInResp:

  193.     properties:

  194.       is_can_sign_in:

  195.         type: boolean

  196.     type: object

  197.   md.LoginReq:

  198.     properties:

  199.       code:

  200.         example: 验证码

  201.         type: string

  202.       password:

  203.         example: 登录密码

  204.         type: string

  205.       phone:

  206.         example: 手机号

  207.         type: string

  208.     required:

  209.     - password

  210.     - phone

  211.     type: object

  212.   md.LoginResponse:

  213.     properties:

  214.       token:

  215.         type: string

  216.     type: object

  217.   md.MyFansResp:

  218.     properties:

  219.       now_team_assistance_num:

  220.         description: 团队助力人数

  221.         type: integer

  222.       now_team_assistance_reward:

  223.         description: 团队助力收益

  224.         type: string

  225.       now_team_user:

  226.         description: 团队人数

  227.         type: integer

  228.     type: object

  229.   md.MyFansUserListResp:

  230.     properties:

  231.       list:

  232.         items:

  233.           $ref: '#/definitions/md.OneLineUserNode'

  234.         type: array

  235.     type: object

  236.   md.NineDimensionalSpaceResp:

  237.     properties:

  238.       a_lot_of_nums:

  239.         description: 全网至多用户数

  240.         type: string

  241.       space_list:

  242.         description: 数据列表

  243.         items:

  244.           $ref: '#/definitions/md.SpaceListNode'

  245.         type: array

  246.       space_nums:

  247.         description: 空间人数

  248.         type: string

  249.       space_total_nums:

  250.         description: 空间总数

  251.         type: string

  252.     type: object

  253.   md.OneLineUserNode:

  254.     properties:

  255.       avatar_url:

  256.         type: string

  257.       invite_time:

  258.         type: string

  259.       is_online:

  260.         type: boolean

  261.       nickname:

  262.         type: string

  263.     type: object

  264.   md.RealTimePriceResp:

  265.     properties:

  266.       is_rises:

  267.         type: boolean

  268.       now_price:

  269.         type: string

  270.       rises:

  271.         type: string

  272.       user_count:

  273.         type: string

  274.     type: object

  275.   md.RegisterReq:

  276.     properties:

  277.       avatar:

  278.         example: 头像

  279.         type: string

  280.       code:

  281.         example: 验证码

  282.         type: string

  283.       invite_code:

  284.         example: 邀请码

  285.         type: string

  286.       mobile:

  287.         type: string

  288.       nickname:

  289.         example: 昵称

  290.         type: string

  291.       open_id:

  292.         example: 微信openId

  293.         type: string

  294.       sex:

  295.         description: 性别(0:未知 1:男 2:女)

  296.         type: integer

  297.       type:

  298.         example: app:APP注册、h5:H5注册

  299.         type: string

  300.       union_id:

  301.         example: 微信UnionId

  302.         type: string

  303.     required:

  304.     - mobile

  305.     type: object

  306.   md.Response:

  307.     properties:

  308.       code:

  309.         example: 响应码

  310.         type: string

  311.       data:

  312.         description: 内容

  313.       msg:

  314.         example: 具体错误原因

  315.         type: string

  316.     type: object

  317.   md.SpaceListNode:

  318.     properties:

  319.       max_count:

  320.         description: 最大容纳人数

  321.         type: string

  322.       name:

  323.         description: 维度

  324.         type: string

  325.       now_count:

  326.         description: 当前人数

  327.         type: string

  328.     type: object

  329.   md.TransferTypeList:

  330.     properties:

  331.       available_integral_list:

  332.         allOf:

  333.         - $ref: '#/definitions/md.IntegralList'

  334.         description: 可用积分列表

  335.       settlement_integral_list:

  336.         allOf:

  337.         - $ref: '#/definitions/md.IntegralList'

  338.         description: 结算积分列表

  339.     type: object

  340.   md.TransferTypeNode:

  341.     properties:

  342.       name:

  343.         type: string

  344.       value:

  345.         type: string

  346.     type: object

  347. host: ddxq.izhim.com

  348. info:

  349.   contact:

  350.     email: 1239118001@qq.com

  351.     name: dengbiao

  352.     url: http://www.swagger.io/support

  353.   description: APP客户端-Api接口

  354.   license:

  355.     name: Apache 2.0

  356.     url: http://www.apache.org/licenses/LICENSE-2.0.html

  357.   termsOfService: http://swagger.io/terms/

  358.   title: 蛋蛋星球-APP客户端

  359.   version: "1.0"

  360. paths:

  361.   /api/v1/addFriend/eggEnergyDetails:

  362.     post:

  363.       consumes:

  364.       - application/json

  365.       description: 蛋蛋能量明细(获取)

  366.       parameters:

  367.       - description: 验证参数Bearer和token空格拼接

  368.         in: header

  369.         name: Authorization

  370.         required: true

  371.         type: string

  372.       - description: 分页类型必填

  373.         in: body

  374.         name: req

  375.         required: true

  376.         schema:

  377.           $ref: '#/definitions/md.EggEnergyDetailReq'

  378.       produces:

  379.       - application/json

  380.       responses:

  381.         "200":

  382.           description: 具体数据

  383.           schema:

  384.             $ref: '#/definitions/md.EggEnergyDetailResp'

  385.         "400":

  386.           description: 具体错误

  387.           schema:

  388.             $ref: '#/definitions/md.Response'

  389.       summary: 蛋蛋星球-添加好友-蛋蛋能量明细(获取)

  390.       tags:

  391.       - 添加好友

  392.   /api/v1/addFriend/eggPointDetails:

  393.     post:

  394.       consumes:

  395.       - application/json

  396.       description: 蛋蛋积分明细(获取)

  397.       parameters:

  398.       - description: 验证参数Bearer和token空格拼接

  399.         in: header

  400.         name: Authorization

  401.         required: true

  402.         type: string

  403.       - description: 分页类型必填

  404.         in: body

  405.         name: req

  406.         required: true

  407.         schema:

  408.           $ref: '#/definitions/md.EggPointDetailsReq'

  409.       produces:

  410.       - application/json

  411.       responses:

  412.         "200":

  413.           description: 具体数据

  414.           schema:

  415.             $ref: '#/definitions/md.EggPointDetailsResp'

  416.         "400":

  417.           description: 具体错误

  418.           schema:

  419.             $ref: '#/definitions/md.Response'

  420.       summary: 蛋蛋星球-添加好友-蛋蛋积分明细(获取)

  421.       tags:

  422.       - 添加好友

  423.   /api/v1/addFriend/myFans:

  424.     get:

  425.       consumes:

  426.       - application/json

  427.       description: 团队加速速率(获取)

  428.       parameters:

  429.       - description: 验证参数Bearer和token空格拼接

  430.         in: header

  431.         name: Authorization

  432.         required: true

  433.         type: string

  434.       produces:

  435.       - application/json

  436.       responses:

  437.         "200":

  438.           description: 具体数据

  439.           schema:

  440.             $ref: '#/definitions/md.MyFansResp'

  441.         "400":

  442.           description: 具体错误

  443.           schema:

  444.             $ref: '#/definitions/md.Response'

  445.       summary: 蛋蛋星球-添加好友-粉丝团队-我的粉丝-团队加速速率(获取)

  446.       tags:

  447.       - 添加好友

  448.   /api/v1/addFriend/myFansUserList:

  449.     get:

  450.       consumes:

  451.       - application/json

  452.       description: 在线好友列表(获取)

  453.       parameters:

  454.       - description: 验证参数Bearer和token空格拼接

  455.         in: header

  456.         name: Authorization

  457.         required: true

  458.         type: string

  459.       produces:

  460.       - application/json

  461.       responses:

  462.         "200":

  463.           description: 具体数据

  464.           schema:

  465.             $ref: '#/definitions/md.MyFansUserListResp'

  466.         "400":

  467.           description: 具体错误

  468.           schema:

  469.             $ref: '#/definitions/md.Response'

  470.       summary: 蛋蛋星球-添加好友-粉丝团队-我的粉丝-在线好友列表(获取)

  471.       tags:

  472.       - 添加好友

  473.   /api/v1/addFriend/nineDimensionalSpace:

  474.     get:

  475.       consumes:

  476.       - application/json

  477.       description: 九维空间(获取)

  478.       parameters:

  479.       - description: 验证参数Bearer和token空格拼接

  480.         in: header

  481.         name: Authorization

  482.         required: true

  483.         type: string

  484.       produces:

  485.       - application/json

  486.       responses:

  487.         "200":

  488.           description: 具体数据

  489.           schema:

  490.             $ref: '#/definitions/md.NineDimensionalSpaceResp'

  491.         "400":

  492.           description: 具体错误

  493.           schema:

  494.             $ref: '#/definitions/md.Response'

  495.       summary: 蛋蛋星球-添加好友-粉丝团队-九维空间(获取)

  496.       tags:

  497.       - 添加好友

  498.   /api/v1/comm/getOssUrl:

  499.     get:

  500.       consumes:

  501.       - application/json

  502.       description: 上传许可链接(获取)

  503.       parameters:

  504.       - description: 验证参数Bearer和token空格拼接

  505.         in: header

  506.         name: Authorization

  507.         required: true

  508.         type: string

  509.       produces:

  510.       - application/json

  511.       responses:

  512.         "200":

  513.           description: 许可链接

  514.           schema:

  515.             type: string

  516.         "400":

  517.           description: 具体错误

  518.           schema:

  519.             $ref: '#/definitions/md.Response'

  520.       summary: 通用请求-对象存储-上传许可链接(获取)

  521.       tags:

  522.       - 对象存储

  523.   /api/v1/homePage/adRule:

  524.     get:

  525.       consumes:

  526.       - application/json

  527.       description: 视频奖励规则(获取)

  528.       parameters:

  529.       - description: 验证参数Bearer和token空格拼接

  530.         in: header

  531.         name: Authorization

  532.         required: true

  533.         type: string

  534.       produces:

  535.       - application/json

  536.       responses:

  537.         "200":

  538.           description: 具体数据

  539.           schema:

  540.             $ref: '#/definitions/md.HomePageWatchAdRuleResp'

  541.         "400":

  542.           description: 具体错误

  543.           schema:

  544.             $ref: '#/definitions/md.Response'

  545.       summary: 蛋蛋星球-主页-视频奖励规则(获取)

  546.       tags:

  547.       - 主页

  548.   /api/v1/homePage/index:

  549.     get:

  550.       consumes:

  551.       - application/json

  552.       description: 基础信息(获取)

  553.       parameters:

  554.       - description: 验证参数Bearer和token空格拼接

  555.         in: header

  556.         name: Authorization

  557.         required: true

  558.         type: string

  559.       produces:

  560.       - application/json

  561.       responses:

  562.         "200":

  563.           description: 具体数据

  564.           schema:

  565.             $ref: '#/definitions/md.HomePageResp'

  566.         "400":

  567.           description: 具体错误

  568.           schema:

  569.             $ref: '#/definitions/md.Response'

  570.       summary: 蛋蛋星球-主页-基础信息(获取)

  571.       tags:

  572.       - 主页

  573.   /api/v1/homePage/isCanGetRedPackage:

  574.     get:

  575.       consumes:

  576.       - application/json

  577.       description: 是否可以领取红包(获取)

  578.       parameters:

  579.       - description: 验证参数Bearer和token空格拼接

  580.         in: header

  581.         name: Authorization

  582.         required: true

  583.         type: string

  584.       produces:

  585.       - application/json

  586.       responses:

  587.         "200":

  588.           description: 具体数据

  589.           schema:

  590.             $ref: '#/definitions/md.IsCanGetRedPackageResp'

  591.         "400":

  592.           description: 具体错误

  593.           schema:

  594.             $ref: '#/definitions/md.Response'

  595.       summary: 蛋蛋星球-主页-是否领取红包(获取)

  596.       tags:

  597.       - 主页

  598.   /api/v1/homePage/isCanSignIn:

  599.     get:

  600.       consumes:

  601.       - application/json

  602.       description: 是否可以签到(获取)

  603.       parameters:

  604.       - description: 验证参数Bearer和token空格拼接

  605.         in: header

  606.         name: Authorization

  607.         required: true

  608.         type: string

  609.       produces:

  610.       - application/json

  611.       responses:

  612.         "200":

  613.           description: 具体数据

  614.           schema:

  615.             $ref: '#/definitions/md.IsCanSignInResp'

  616.         "400":

  617.           description: 具体错误

  618.           schema:

  619.             $ref: '#/definitions/md.Response'

  620.       summary: 蛋蛋星球-主页-是否能签到(获取)

  621.       tags:

  622.       - 主页

  623.   /api/v1/homePage/realTimePrice:

  624.     get:

  625.       consumes:

  626.       - application/json

  627.       description: 实时数据(获取)

  628.       parameters:

  629.       - description: 验证参数Bearer和token空格拼接

  630.         in: header

  631.         name: Authorization

  632.         required: true

  633.         type: string

  634.       produces:

  635.       - application/json

  636.       responses:

  637.         "200":

  638.           description: 具体数据

  639.           schema:

  640.             $ref: '#/definitions/md.RealTimePriceResp'

  641.         "400":

  642.           description: 具体错误

  643.           schema:

  644.             $ref: '#/definitions/md.Response'

  645.       summary: 蛋蛋星球-主页-实时数据(获取)

  646.       tags:

  647.       - 主页

  648.   /api/v1/test:

  649.     get:

  650.       consumes:

  651.       - application/json

  652.       description: Demo样例测试

  653.       parameters:

  654.       - description: 任意参数

  655.         in: body

  656.         name: req

  657.         required: true

  658.         schema: {}

  659.       produces:

  660.       - application/json

  661.       responses:

  662.         "200":

  663.           description: 返回任意参数

  664.           schema:

  665.             additionalProperties: true

  666.             type: object

  667.         "400":

  668.           description: 具体错误

  669.           schema:

  670.             $ref: '#/definitions/md.Response'

  671.       summary: Demo测试

  672.       tags:

  673.       - Demo

  674.   /v1/login:

  675.     post:

  676.       consumes:

  677.       - application/json

  678.       description: 登入

  679.       parameters:

  680.       - description: 用户名密码

  681.         in: body

  682.         name: req

  683.         required: true

  684.         schema:

  685.           $ref: '#/definitions/md.LoginReq'

  686.       produces:

  687.       - application/json

  688.       responses:

  689.         "200":

  690.           description: token

  691.           schema:

  692.             $ref: '#/definitions/md.LoginResponse'

  693.         "400":

  694.           description: 具体错误

  695.           schema:

  696.             $ref: '#/definitions/md.Response'

  697.       summary: 登陆

  698.       tags:

  699.       - 登录

  700.   /v1/register:

  701.     post:

  702.       consumes:

  703.       - application/json

  704.       description: 注册

  705.       parameters:

  706.       - description: 注册参数

  707.         in: body

  708.         name: req

  709.         required: true

  710.         schema:

  711.           $ref: '#/definitions/md.RegisterReq'

  712.       produces:

  713.       - application/json

  714.       responses:

  715.         "200":

  716.           description: 登录成功返回

  717.           schema:

  718.             $ref: '#/definitions/md.LoginResponse'

  719.         "400":

  720.           description: 具体错误

  721.           schema:

  722.             $ref: '#/definitions/md.Response'

  723.       summary: 注册

  724.       tags:

  725.       - 注册

  726. swagger: "2.0"