EggPlanet
/
egg_admin
3
0
Atdalīts 0
Kods Problēmas 0 Izmaiņu pieprasījumi 0 Laidieni 0 Vikivietne Aktivitāte
蛋蛋星球 后台端
Nevar pievienot vairāk kā 25 tēmas Tēmai ir jāsākas ar burtu vai ciparu, tā var saturēt domu zīmes ('-') un var būt līdz 35 simboliem gara.
27 Revīzijas
1 Atzars
6.1 MiB
 
 
 
 
 
Koks: 108fa1445e
Atzari Tagi
${ item.name }
Izveidot atzaru ${ searchTerm }
no '108fa1445e'
${ noResults }
egg_admin/docs/swagger.yaml

709 rindas
18 KiB
Neapstrādāts Vainot Vēsture 

  1. definitions:

  2.   md.AddCommunityDividendsReq:

  3.     properties:

  4.       name:

  5.         example: 社区分红名称

  6.         type: string

  7.       nums:

  8.         description: 社区分红数量

  9.         type: integer

  10.     type: object

  11.   md.AddCommunityDividendsWithUserReq:

  12.     properties:

  13.       memo:

  14.         example: 备注

  15.         type: string

  16.       uid:

  17.         description: 新增社区长用户 ID

  18.         type: integer

  19.     type: object

  20.   md.AddFreePublishUserReq:

  21.     properties:

  22.       uid:

  23.         type: integer

  24.     type: object

  25.   md.BasicSetting:

  26.     properties:

  27.       id:

  28.         type: integer

  29.       is_open:

  30.         description: 是否开启(1:开启 0:关闭)

  31.         type: integer

  32.       is_self_active_get_team_revenue:

  33.         description: 会员本人没有日活，没有圈层奖励(1:开启 0:关闭)

  34.         type: integer

  35.       originator_uid:

  36.         description: 创始人uid

  37.         type: integer

  38.       several_rows:

  39.         description: 几排

  40.         type: integer

  41.       several_times:

  42.         description: 几乘

  43.         type: integer

  44.       system_punish_replace:

  45.         description: 是否位置滑落 被新用户替换 0否 1是

  46.         type: integer

  47.       system_punish_replace_value:

  48.         description: xx天未活跃，处罚滑落

  49.         type: integer

  50.     type: object

  51.   md.DailyActivityAnalysisTopData:

  52.     properties:

  53.       activity_count:

  54.         description: 子节点活跃天数

  55.         type: integer

  56.       team_activity_user_count:

  57.         description: 子节点活跃人数

  58.         type: integer

  59.       team_user_count:

  60.         description: 团队人数

  61.         type: integer

  62.     type: object

  63.   md.ExchangeUserPositionReq:

  64.     properties:

  65.       position_1:

  66.         description: 位置1，具体值取返回数据中的 system_id

  67.         type: integer

  68.       position_2:

  69.         description: 位置2，具体值取返回数据中的 system_id

  70.         type: integer

  71.     type: object

  72.   md.FindSubUserRelationshipMapResp:

  73.     properties:

  74.       basic_setting:

  75.         allOf:

  76.         - $ref: '#/definitions/md.BasicSetting'

  77.         description: 公排设置

  78.       search_uid:

  79.         description: 查找的用户 ID

  80.         type: string

  81.       sub_user:

  82.         allOf:

  83.         - $ref: '#/definitions/md.SubUser'

  84.         description: 上级用户信息

  85.     type: object

  86.   md.FreePublishUserNode:

  87.     properties:

  88.       nickname:

  89.         example: 昵称

  90.         type: string

  91.       phone:

  92.         example: 手机号

  93.         type: string

  94.       uid:

  95.         type: integer

  96.     type: object

  97.   md.GetFreePublishUserReq:

  98.     properties:

  99.       limit:

  100.         description: 每页大小

  101.         type: integer

  102.       page:

  103.         description: 当前页数

  104.         type: integer

  105.       uid:

  106.         description: 筛选的用户 ID

  107.         type: integer

  108.     type: object

  109.   md.GetFreePublishUserResp:

  110.     properties:

  111.       list:

  112.         description: 免罚用户列表

  113.         items:

  114.           $ref: '#/definitions/md.FreePublishUserNode'

  115.         type: array

  116.       paginate:

  117.         allOf:

  118.         - $ref: '#/definitions/md.Paginate'

  119.         description: 分页信息

  120.     type: object

  121.   md.GetPublicPlatoonBasicResp:

  122.     properties:

  123.       is_open:

  124.         description: 是否开启(1:开启 0:关闭)

  125.         type: integer

  126.       is_self_active_get_team_revenue:

  127.         description: 会员本人没有日活，没有圈层奖励(1:开启 0:关闭)

  128.         type: integer

  129.       originator_uid:

  130.         description: 创始人uid

  131.         type: integer

  132.       several_rows:

  133.         description: 几排

  134.         type: integer

  135.       several_times:

  136.         description: 几乘

  137.         type: integer

  138.       system_punish_replace:

  139.         description: 是否位置滑落 被新用户替换 0否 1是

  140.         type: integer

  141.       system_punish_replace_value:

  142.         description: xx天未活跃，处罚滑落

  143.         type: integer

  144.     type: object

  145.   md.LoginReq:

  146.     properties:

  147.       code:

  148.         example: 验证码

  149.         type: string

  150.       password:

  151.         example: 登录密码

  152.         type: string

  153.       username:

  154.         example: 登录账号

  155.         type: string

  156.     required:

  157.     - password

  158.     - username

  159.     type: object

  160.   md.LoginResponse:

  161.     properties:

  162.       token:

  163.         type: string

  164.     type: object

  165.   md.Paginate:

  166.     properties:

  167.       limit:

  168.         description: 每页大小

  169.         type: integer

  170.       page:

  171.         description: 页数

  172.         type: integer

  173.       total:

  174.         description: 总数据量

  175.         type: integer

  176.     type: object

  177.   md.Response:

  178.     properties:

  179.       code:

  180.         example: 响应码

  181.         type: string

  182.       data:

  183.         description: 内容

  184.       msg:

  185.         example: 具体错误原因

  186.         type: string

  187.     type: object

  188.   md.SonUserDailyActivityAnalysisNode:

  189.     properties:

  190.       activity_day_nums:

  191.         description: 活跃子节点活跃天数

  192.         type: integer

  193.       nickname:

  194.         example: 昵称

  195.         type: string

  196.       phone:

  197.         example: 手机号

  198.         type: string

  199.       uid:

  200.         description: 查询用户活跃子节点 ID

  201.         type: integer

  202.     type: object

  203.   md.SubUser:

  204.     properties:

  205.       avatar_url:

  206.         example: 头像

  207.         type: string

  208.       level:

  209.         description: 整个系统中的等级

  210.         type: integer

  211.       nickname:

  212.         example: 昵称

  213.         type: string

  214.       phone:

  215.         example: 手机号

  216.         type: string

  217.       pid:

  218.         type: integer

  219.       position:

  220.         description: 以pid1为创始人中网的位置

  221.         type: integer

  222.       uid:

  223.         type: integer

  224.     type: object

  225.   md.TreeNode:

  226.     properties:

  227.       avatar_url:

  228.         example: 头像

  229.         type: string

  230.       level:

  231.         type: integer

  232.       nickname:

  233.         example: 昵称

  234.         type: string

  235.       phone:

  236.         example: 手机号

  237.         type: string

  238.       pid:

  239.         type: integer

  240.       position:

  241.         type: integer

  242.       son:

  243.         items:

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

  245.         type: array

  246.       system_id:

  247.         description: 公排网中id

  248.         type: integer

  249.       uid:

  250.         type: integer

  251.     type: object

  252.   md.UpdatePublicPlatoonBasicReq:

  253.     properties:

  254.       is_open:

  255.         description: 是否开启(1:开启 0:关闭)

  256.         type: integer

  257.       is_self_active_get_team_revenue:

  258.         description: 会员本人没有日活，没有圈层奖励(1:开启 0:关闭)

  259.         type: integer

  260.       originator_uid:

  261.         description: 创始人uid

  262.         type: integer

  263.       several_rows:

  264.         description: 几排

  265.         type: integer

  266.       several_times:

  267.         description: 几乘

  268.         type: integer

  269.       system_punish_replace:

  270.         description: 是否位置滑落 被新用户替换 0否 1是

  271.         type: integer

  272.       system_punish_replace_value:

  273.         description: xx天未活跃，处罚滑落

  274.         type: integer

  275.     type: object

  276.   md.UserDailyActivityAnalysisReq:

  277.     properties:

  278.       end_date:

  279.         example: 结束日期

  280.         type: string

  281.       start_date:

  282.         example: 开始日期

  283.         type: string

  284.       uid:

  285.         description: 查询用户 ID

  286.         type: integer

  287.     type: object

  288.   md.UserDailyActivityAnalysisResp:

  289.     properties:

  290.       son_user_data:

  291.         description: 被查询用户子节点信息

  292.         items:

  293.           $ref: '#/definitions/md.SonUserDailyActivityAnalysisNode'

  294.         type: array

  295.       top_data:

  296.         allOf:

  297.         - $ref: '#/definitions/md.DailyActivityAnalysisTopData'

  298.         description: 统计信息

  299.     type: object

  300. host: localhost:4001

  301. info:

  302.   contact:

  303.     email: 1239118001@qq.com

  304.     name: dengbiao

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

  306.   description: 管理后台接口文档

  307.   license:

  308.     name: Apache 2.0

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

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

  311.   title: 蛋蛋星球-管理后台

  312.   version: "1.0"

  313. paths:

  314.   /api/demo:

  315.     post:

  316.       consumes:

  317.       - application/json

  318.       description: Demo样例测试

  319.       parameters:

  320.       - description: 用户名密码

  321.         in: body

  322.         name: req

  323.         required: true

  324.         schema: {}

  325.       produces:

  326.       - application/json

  327.       responses:

  328.         "200":

  329.           description: token

  330.           schema:

  331.             additionalProperties: true

  332.             type: object

  333.         "400":

  334.           description: 具体错误

  335.           schema:

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

  337.       summary: Demo测试

  338.       tags:

  339.       - Demo

  340.   /api/institutionalManagement/publicPlatoon/communityDividends/communityDividendsAdd:

  341.     post:

  342.       consumes:

  343.       - application/json

  344.       description: 社区分红(新增)

  345.       parameters:

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

  347.         in: header

  348.         name: Authorization

  349.         required: true

  350.         type: string

  351.       - description: 分红名称、分红总量

  352.         in: body

  353.         name: req

  354.         required: true

  355.         schema:

  356.           $ref: '#/definitions/md.AddCommunityDividendsReq'

  357.       produces:

  358.       - application/json

  359.       responses:

  360.         "200":

  361.           description: 插入数据 ID

  362.           schema:

  363.             type: int

  364.         "400":

  365.           description: 具体错误

  366.           schema:

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

  368.       summary: 制度中心-公排管理-社区分红(新增)

  369.       tags:

  370.       - 公排管理

  371.   /api/institutionalManagement/publicPlatoon/communityDividends/communityDividendsWithUserAdd:

  372.     post:

  373.       consumes:

  374.       - application/json

  375.       description: 社区长列表(新增)

  376.       parameters:

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

  378.         in: header

  379.         name: Authorization

  380.         required: true

  381.         type: string

  382.       - description: 新增社区长 ID、备注

  383.         in: body

  384.         name: req

  385.         required: true

  386.         schema:

  387.           $ref: '#/definitions/md.AddCommunityDividendsWithUserReq'

  388.       produces:

  389.       - application/json

  390.       responses:

  391.         "200":

  392.           description: 插入数据 ID

  393.           schema:

  394.             type: int

  395.         "400":

  396.           description: 具体错误

  397.           schema:

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

  399.       summary: 制度中心-公排管理-社区长列表(新增)

  400.       tags:

  401.       - 公排管理

  402.   /api/institutionalManagement/publicPlatoon/exchangeUserPosition:

  403.     post:

  404.       consumes:

  405.       - application/json

  406.       description: 关系分布图(位置转换)

  407.       parameters:

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

  409.         in: header

  410.         name: Authorization

  411.         required: true

  412.         type: string

  413.       - description: 需要交换的两个位置

  414.         in: body

  415.         name: req

  416.         required: true

  417.         schema:

  418.           $ref: '#/definitions/md.ExchangeUserPositionReq'

  419.       produces:

  420.       - application/json

  421.       responses:

  422.         "200":

  423.           description: 成功返回

  424.           schema:

  425.             type: ""

  426.         "400":

  427.           description: 具体错误

  428.           schema:

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

  430.       summary: 制度中心-公排管理-关系分布图(位置转换)

  431.       tags:

  432.       - 公排管理

  433.   /api/institutionalManagement/publicPlatoon/findSubUserRelationshipMap:

  434.     get:

  435.       consumes:

  436.       - application/json

  437.       description: 关系分布图(获取指定用户上级)

  438.       parameters:

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

  440.         in: header

  441.         name: Authorization

  442.         required: true

  443.         type: string

  444.       - description: 用户ID

  445.         in: query

  446.         name: uid

  447.         required: true

  448.         type: string

  449.       produces:

  450.       - application/json

  451.       responses:

  452.         "200":

  453.           description: 具体数据

  454.           schema:

  455.             $ref: '#/definitions/md.FindSubUserRelationshipMapResp'

  456.         "400":

  457.           description: 具体错误

  458.           schema:

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

  460.       summary: 制度中心-公排管理-关系分布图(获取指定用户上级)

  461.       tags:

  462.       - 公排管理

  463.   /api/institutionalManagement/publicPlatoon/findUserRelationshipMap:

  464.     get:

  465.       consumes:

  466.       - application/json

  467.       description: 关系分布图(获取指定用户下级)

  468.       parameters:

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

  470.         in: header

  471.         name: Authorization

  472.         required: true

  473.         type: string

  474.       - description: 用户ID

  475.         in: query

  476.         name: uid

  477.         required: true

  478.         type: string

  479.       produces:

  480.       - application/json

  481.       responses:

  482.         "200":

  483.           description: 具体数据

  484.           schema:

  485.             $ref: '#/definitions/md.TreeNode'

  486.         "400":

  487.           description: 具体错误

  488.           schema:

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

  490.       summary: 制度中心-公排管理-关系分布图(获取指定用户下级)

  491.       tags:

  492.       - 公排管理

  493.   /api/institutionalManagement/publicPlatoon/getBasic:

  494.     get:

  495.       consumes:

  496.       - application/json

  497.       description: 公排基础设置(获取)

  498.       parameters:

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

  500.         in: header

  501.         name: Authorization

  502.         required: true

  503.         type: string

  504.       produces:

  505.       - application/json

  506.       responses:

  507.         "200":

  508.           description: 具体数据

  509.           schema:

  510.             $ref: '#/definitions/md.GetPublicPlatoonBasicResp'

  511.         "400":

  512.           description: 具体错误

  513.           schema:

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

  515.       summary: 制度中心-公排管理-公排基础设置(获取)

  516.       tags:

  517.       - 公排管理

  518.   /api/institutionalManagement/publicPlatoon/publicPlatoonUserFreePunish/index:

  519.     post:

  520.       consumes:

  521.       - application/json

  522.       description: 免罚用户(查询)

  523.       parameters:

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

  525.         in: header

  526.         name: Authorization

  527.         required: true

  528.         type: string

  529.       - description: 页数和行数必填，uid选填

  530.         in: body

  531.         name: req

  532.         required: true

  533.         schema:

  534.           $ref: '#/definitions/md.GetFreePublishUserReq'

  535.       produces:

  536.       - application/json

  537.       responses:

  538.         "200":

  539.           description: 成功返回

  540.           schema:

  541.             $ref: '#/definitions/md.GetFreePublishUserResp'

  542.         "400":

  543.           description: 具体错误

  544.           schema:

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

  546.       summary: 制度中心-公排管理-免罚用户(查询)

  547.       tags:

  548.       - 公排管理

  549.   /api/institutionalManagement/publicPlatoon/publicPlatoonUserFreePunish/save:

  550.     post:

  551.       consumes:

  552.       - application/json

  553.       description: 免罚用户(新增)

  554.       parameters:

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

  556.         in: header

  557.         name: Authorization

  558.         required: true

  559.         type: string

  560.       - description: 页数和行数必填，uid选填

  561.         in: body

  562.         name: req

  563.         required: true

  564.         schema:

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

  566.       produces:

  567.       - application/json

  568.       responses:

  569.         "200":

  570.           description: 插入数据 ID

  571.           schema:

  572.             type: int

  573.         "400":

  574.           description: 具体错误

  575.           schema:

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

  577.       summary: 制度中心-公排管理-免罚用户(新增)

  578.       tags:

  579.       - 公排管理

  580.   /api/institutionalManagement/publicPlatoon/relationshipMap:

  581.     get:

  582.       consumes:

  583.       - application/json

  584.       description: 关系分布图(获取)

  585.       parameters:

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

  587.         in: header

  588.         name: Authorization

  589.         required: true

  590.         type: string

  591.       - description: phone

  592.         in: query

  593.         name: phone

  594.         required: true

  595.         type: string

  596.       - description: uid

  597.         in: query

  598.         name: uid

  599.         required: true

  600.         type: string

  601.       produces:

  602.       - application/json

  603.       responses:

  604.         "200":

  605.           description: 具体数据

  606.           schema:

  607.             $ref: '#/definitions/md.TreeNode'

  608.         "400":

  609.           description: 具体错误

  610.           schema:

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

  612.       summary: 制度中心-公排管理-关系分布图(获取)

  613.       tags:

  614.       - 公排管理

  615.   /api/institutionalManagement/publicPlatoon/updateBasic:

  616.     put:

  617.       consumes:

  618.       - application/json

  619.       description: 公排基础设置(修改)

  620.       parameters:

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

  622.         in: header

  623.         name: Authorization

  624.         required: true

  625.         type: string

  626.       - description: 公排设置表单内容

  627.         in: body

  628.         name: req

  629.         required: true

  630.         schema:

  631.           $ref: '#/definitions/md.UpdatePublicPlatoonBasicReq'

  632.       produces:

  633.       - application/json

  634.       responses:

  635.         "200":

  636.           description: success

  637.           schema:

  638.             type: string

  639.         "400":

  640.           description: 具体错误

  641.           schema:

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

  643.       summary: 制度中心-公排管理-公排基础设置(修改)

  644.       tags:

  645.       - 公排管理

  646.   /api/institutionalManagement/publicPlatoon/userDailyActivityAnalysis:

  647.     post:

  648.       consumes:

  649.       - application/json

  650.       description: 日活分析

  651.       parameters:

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

  653.         in: header

  654.         name: Authorization

  655.         required: true

  656.         type: string

  657.       - description: 用户 ID、查询开始时间、结束时间

  658.         in: body

  659.         name: req

  660.         required: true

  661.         schema:

  662.           $ref: '#/definitions/md.UserDailyActivityAnalysisReq'

  663.       produces:

  664.       - application/json

  665.       responses:

  666.         "200":

  667.           description: 具体数据

  668.           schema:

  669.             $ref: '#/definitions/md.UserDailyActivityAnalysisResp'

  670.         "400":

  671.           description: 具体错误

  672.           schema:

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

  674.       summary: 制度中心-公排管理-日活分析

  675.       tags:

  676.       - 公排管理

  677.   /api/login:

  678.     post:

  679.       consumes:

  680.       - application/json

  681.       description: 登入

  682.       parameters:

  683.       - description: 用户名密码

  684.         in: body

  685.         name: req

  686.         required: true

  687.         schema:

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

  689.       produces:

  690.       - application/json

  691.       responses:

  692.         "200":

  693.           description: token

  694.           schema:

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

  696.         "400":

  697.           description: 具体错误

  698.           schema:

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

  700.       summary: 登陆

  701.       tags:

  702.       - 登录

  703. securityDefinitions:

  704.   MasterID:

  705.     in: header

  706.     name: MasterID

  707.     type: apiKey

  708. swagger: "2.0"