zhimeng
/
super_ad
2
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
广告平台(总站长使用)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
11 Commits
1 Branch
627 KiB
 
 
 
 
 
 
Tree: 1e4e211082
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '1e4e211082'
${ noResults }
super_ad/docs/swagger.yaml

735 lines
17 KiB
Raw Blame History 

  1. definitions:

  2.   md.AddAdminReq:

  3.     properties:

  4.       memo:

  5.         type: string

  6.       password:

  7.         type: string

  8.       username:

  9.         type: string

  10.     required:

  11.     - password

  12.     - username

  13.     type: object

  14.   md.AddRoleReq:

  15.     properties:

  16.       memo:

  17.         type: string

  18.       name:

  19.         type: string

  20.     required:

  21.     - memo

  22.     - name

  23.     type: object

  24.   md.AdminListReq:

  25.     properties:

  26.       limit:

  27.         type: integer

  28.       page:

  29.         type: integer

  30.       state:

  31.         type: integer

  32.       username:

  33.         type: string

  34.     type: object

  35.   md.AgentQualificationEnterpriseAuditReq:

  36.     properties:

  37.       agent_id:

  38.         type: integer

  39.       memo:

  40.         type: string

  41.       state:

  42.         type: string

  43.     type: object

  44.   md.AgentQualificationEnterpriseReq:

  45.     properties:

  46.       limit:

  47.         type: integer

  48.       name:

  49.         type: string

  50.       page:

  51.         type: integer

  52.       state:

  53.         type: string

  54.     type: object

  55.   md.BindAdminRoleReq:

  56.     properties:

  57.       adm_id:

  58.         type: integer

  59.       role_ids:

  60.         items:

  61.           type: integer

  62.         type: array

  63.     required:

  64.     - adm_id

  65.     type: object

  66.   md.LoginReq:

  67.     properties:

  68.       code:

  69.         example: 验证码

  70.         type: string

  71.       password:

  72.         example: 登录密码

  73.         type: string

  74.       username:

  75.         example: 登录账号

  76.         type: string

  77.     required:

  78.     - password

  79.     - username

  80.     type: object

  81.   md.LoginResponse:

  82.     properties:

  83.       token:

  84.         type: string

  85.     type: object

  86.   md.MediumQualificationEnterpriseAuditReq:

  87.     properties:

  88.       medium_id:

  89.         type: integer

  90.       memo:

  91.         type: string

  92.       state:

  93.         type: string

  94.     type: object

  95.   md.MediumQualificationEnterpriseReq:

  96.     properties:

  97.       limit:

  98.         type: integer

  99.       name:

  100.         type: string

  101.       page:

  102.         type: integer

  103.       state:

  104.         type: string

  105.     type: object

  106.   md.Response:

  107.     properties:

  108.       code:

  109.         example: 响应码

  110.         type: string

  111.       data:

  112.         description: 内容

  113.       msg:

  114.         example: 具体错误原因

  115.         type: string

  116.     type: object

  117.   md.RoleBindPermissionGroupReq:

  118.     properties:

  119.       permission_ids:

  120.         items:

  121.           type: integer

  122.         type: array

  123.       role_id:

  124.         type: integer

  125.     required:

  126.     - role_id

  127.     type: object

  128.   md.UpdateAdminReq:

  129.     properties:

  130.       adm_id:

  131.         type: integer

  132.       memo:

  133.         type: string

  134.       password:

  135.         type: string

  136.       username:

  137.         type: string

  138.     required:

  139.     - adm_id

  140.     - password

  141.     - username

  142.     type: object

  143.   md.UpdateAdminStateReq:

  144.     properties:

  145.       adm_id:

  146.         type: integer

  147.       state:

  148.         type: integer

  149.     required:

  150.     - adm_id

  151.     - state

  152.     type: object

  153.   md.UpdateRoleReq:

  154.     properties:

  155.       memo:

  156.         type: string

  157.       name:

  158.         type: string

  159.       role_id:

  160.         type: integer

  161.     required:

  162.     - memo

  163.     - name

  164.     - role_id

  165.     type: object

  166.   md.UpdateRoleStateReq:

  167.     properties:

  168.       role_id:

  169.         type: integer

  170.       state:

  171.         type: integer

  172.     required:

  173.     - role_id

  174.     - state

  175.     type: object

  176. host: localhost:1001 or advertisement.dengbiao.top

  177. info:

  178.   contact:

  179.     email: 1239118001@qq.com

  180.     name: dengbiao

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

  182.   description: 总站长后台接口

  183.   license:

  184.     name: Apache 2.0

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

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

  187.   title: 广告联盟-总站长平台

  188.   version: "1.0"

  189. paths:

  190.   /api/agentQualification/enterprise:

  191.     post:

  192.       consumes:

  193.       - application/json

  194.       description: 渠道资质-主体资质

  195.       parameters:

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

  197.         in: header

  198.         name: Authorization

  199.         required: true

  200.         type: string

  201.       - description: 请求参数

  202.         in: body

  203.         name: args

  204.         required: true

  205.         schema:

  206.           $ref: '#/definitions/md.AgentQualificationEnterpriseReq'

  207.       produces:

  208.       - application/json

  209.       responses:

  210.         "200":

  211.           description: 具体看返回内容

  212.           schema:

  213.             type: string

  214.         "400":

  215.           description: 具体错误

  216.           schema:

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

  218.       summary: 主体资质

  219.       tags:

  220.       - 渠道资质

  221.   /api/agentQualification/enterprise/audit:

  222.     post:

  223.       consumes:

  224.       - application/json

  225.       description: 渠道资质-主体资质审核

  226.       parameters:

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

  228.         in: header

  229.         name: Authorization

  230.         required: true

  231.         type: string

  232.       - description: 请求参数

  233.         in: body

  234.         name: args

  235.         required: true

  236.         schema:

  237.           $ref: '#/definitions/md.AgentQualificationEnterpriseAuditReq'

  238.       produces:

  239.       - application/json

  240.       responses:

  241.         "200":

  242.           description: 具体看返回内容

  243.           schema:

  244.             type: string

  245.         "400":

  246.           description: 具体错误

  247.           schema:

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

  249.       summary: 主体资质审核

  250.       tags:

  251.       - 渠道资质

  252.   /api/login:

  253.     post:

  254.       consumes:

  255.       - application/json

  256.       description: 登入

  257.       parameters:

  258.       - description: 用户名密码

  259.         in: body

  260.         name: req

  261.         required: true

  262.         schema:

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

  264.       produces:

  265.       - application/json

  266.       responses:

  267.         "200":

  268.           description: token

  269.           schema:

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

  271.         "400":

  272.           description: 具体错误

  273.           schema:

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

  275.       summary: 登陆

  276.       tags:

  277.       - 登录注册

  278.   /api/mediumQualification/enterprise:

  279.     post:

  280.       consumes:

  281.       - application/json

  282.       description: 渠道资质-主体资质

  283.       parameters:

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

  285.         in: header

  286.         name: Authorization

  287.         required: true

  288.         type: string

  289.       - description: 请求参数

  290.         in: body

  291.         name: args

  292.         required: true

  293.         schema:

  294.           $ref: '#/definitions/md.MediumQualificationEnterpriseReq'

  295.       produces:

  296.       - application/json

  297.       responses:

  298.         "200":

  299.           description: 具体看返回内容

  300.           schema:

  301.             type: string

  302.         "400":

  303.           description: 具体错误

  304.           schema:

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

  306.       summary: 主体资质

  307.       tags:

  308.       - 渠道资质

  309.   /api/mediumQualification/enterprise/audit:

  310.     post:

  311.       consumes:

  312.       - application/json

  313.       description: 渠道资质-主体资质审核

  314.       parameters:

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

  316.         in: header

  317.         name: Authorization

  318.         required: true

  319.         type: string

  320.       - description: 请求参数

  321.         in: body

  322.         name: args

  323.         required: true

  324.         schema:

  325.           $ref: '#/definitions/md.MediumQualificationEnterpriseAuditReq'

  326.       produces:

  327.       - application/json

  328.       responses:

  329.         "200":

  330.           description: 具体看返回内容

  331.           schema:

  332.             type: string

  333.         "400":

  334.           description: 具体错误

  335.           schema:

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

  337.       summary: 主体资质审核

  338.       tags:

  339.       - 渠道资质

  340.   /api/role/addAdmin:

  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: args

  354.         required: true

  355.         schema:

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

  357.       produces:

  358.       - application/json

  359.       responses:

  360.         "200":

  361.           description: success

  362.           schema:

  363.             type: string

  364.         "400":

  365.           description: 具体错误

  366.           schema:

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

  368.       summary: 新增管理员

  369.       tags:

  370.       - 权限管理

  371.   /api/role/addRole:

  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: 请求参数

  383.         in: body

  384.         name: args

  385.         required: true

  386.         schema:

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

  388.       produces:

  389.       - application/json

  390.       responses:

  391.         "200":

  392.           description: success

  393.           schema:

  394.             type: string

  395.         "400":

  396.           description: 具体错误

  397.           schema:

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

  399.       summary: 添加角色

  400.       tags:

  401.       - 权限管理

  402.   /api/role/adminInfo:

  403.     get:

  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: 管理员id

  414.         in: query

  415.         name: adm_id

  416.         required: true

  417.         type: string

  418.       produces:

  419.       - application/json

  420.       responses:

  421.         "200":

  422.           description: 具体看返回内容

  423.           schema:

  424.             type: string

  425.         "400":

  426.           description: 具体错误

  427.           schema:

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

  429.       summary: 管理员信息

  430.       tags:

  431.       - 权限管理

  432.   /api/role/adminList:

  433.     post:

  434.       consumes:

  435.       - application/json

  436.       description: 权限管理-管理员列表

  437.       parameters:

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

  439.         in: header

  440.         name: Authorization

  441.         required: true

  442.         type: string

  443.       - description: 请求参数

  444.         in: body

  445.         name: args

  446.         required: true

  447.         schema:

  448.           $ref: '#/definitions/md.AdminListReq'

  449.       produces:

  450.       - application/json

  451.       responses:

  452.         "200":

  453.           description: 具体看返回内容

  454.           schema:

  455.             type: string

  456.         "400":

  457.           description: 具体错误

  458.           schema:

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

  460.       summary: 管理员列表

  461.       tags:

  462.       - 权限管理

  463.   /api/role/bindAdminRole/:

  464.     post:

  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: 请求参数

  475.         in: body

  476.         name: args

  477.         required: true

  478.         schema:

  479.           $ref: '#/definitions/md.BindAdminRoleReq'

  480.       produces:

  481.       - application/json

  482.       responses:

  483.         "200":

  484.           description: success

  485.           schema:

  486.             type: string

  487.         "400":

  488.           description: 具体错误

  489.           schema:

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

  491.       summary: 管理员绑定角色

  492.       tags:

  493.       - 权限管理

  494.   /api/role/deleteAdmin/{$adm_id}:

  495.     delete:

  496.       consumes:

  497.       - application/json

  498.       description: 权限管理-删除管理员

  499.       parameters:

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

  501.         in: header

  502.         name: Authorization

  503.         required: true

  504.         type: string

  505.       produces:

  506.       - application/json

  507.       responses:

  508.         "200":

  509.           description: success

  510.           schema:

  511.             type: string

  512.         "400":

  513.           description: 具体错误

  514.           schema:

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

  516.       summary: 删除管理员

  517.       tags:

  518.       - 权限管理

  519.   /api/role/deleteRole/{$id}:

  520.     delete:

  521.       consumes:

  522.       - application/json

  523.       description: 权限管理-删除角色

  524.       parameters:

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

  526.         in: header

  527.         name: Authorization

  528.         required: true

  529.         type: string

  530.       - description: 请求参数

  531.         in: body

  532.         name: args

  533.         required: true

  534.         schema:

  535.           $ref: '#/definitions/md.UpdateRoleStateReq'

  536.       produces:

  537.       - application/json

  538.       responses:

  539.         "200":

  540.           description: success

  541.           schema:

  542.             type: string

  543.         "400":

  544.           description: 具体错误

  545.           schema:

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

  547.       summary: 删除角色

  548.       tags:

  549.       - 权限管理

  550.   /api/role/permissionGroupList:

  551.     get:

  552.       consumes:

  553.       - application/json

  554.       description: 权限管理-权限组列表

  555.       parameters:

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

  557.         in: header

  558.         name: Authorization

  559.         required: true

  560.         type: string

  561.       - description: 管理员id

  562.         in: query

  563.         name: adm_id

  564.         required: true

  565.         type: string

  566.       produces:

  567.       - application/json

  568.       responses:

  569.         "200":

  570.           description: 具体看返回内容

  571.           schema:

  572.             type: string

  573.         "400":

  574.           description: 具体错误

  575.           schema:

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

  577.       summary: 权限组列表

  578.       tags:

  579.       - 权限管理

  580.   /api/role/roleBindPermissionGroup:

  581.     post:

  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: 请求参数

  592.         in: body

  593.         name: args

  594.         required: true

  595.         schema:

  596.           $ref: '#/definitions/md.RoleBindPermissionGroupReq'

  597.       produces:

  598.       - application/json

  599.       responses:

  600.         "200":

  601.           description: success

  602.           schema:

  603.             type: string

  604.         "400":

  605.           description: 具体错误

  606.           schema:

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

  608.       summary: 角色绑定权限组

  609.       tags:

  610.       - 权限管理

  611.   /api/role/roleList:

  612.     get:

  613.       consumes:

  614.       - application/json

  615.       description: 权限管理-角色列表

  616.       parameters:

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

  618.         in: header

  619.         name: Authorization

  620.         required: true

  621.         type: string

  622.       produces:

  623.       - application/json

  624.       responses:

  625.         "200":

  626.           description: 具体看返回内容

  627.           schema:

  628.             type: string

  629.         "400":

  630.           description: 具体错误

  631.           schema:

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

  633.       summary: 角色列表

  634.       tags:

  635.       - 权限管理

  636.   /api/role/updateAdmin:

  637.     post:

  638.       consumes:

  639.       - application/json

  640.       description: 权限管理-修改管理员信息

  641.       parameters:

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

  643.         in: header

  644.         name: Authorization

  645.         required: true

  646.         type: string

  647.       - description: 请求参数

  648.         in: body

  649.         name: args

  650.         required: true

  651.         schema:

  652.           $ref: '#/definitions/md.UpdateAdminReq'

  653.       produces:

  654.       - application/json

  655.       responses:

  656.         "200":

  657.           description: success

  658.           schema:

  659.             type: string

  660.         "400":

  661.           description: 具体错误

  662.           schema:

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

  664.       summary: 修改管理员信息

  665.       tags:

  666.       - 权限管理

  667.   /api/role/updateAdminState:

  668.     post:

  669.       consumes:

  670.       - application/json

  671.       description: 权限管理-修改管理员状态

  672.       parameters:

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

  674.         in: header

  675.         name: Authorization

  676.         required: true

  677.         type: string

  678.       - description: 请求参数

  679.         in: body

  680.         name: args

  681.         required: true

  682.         schema:

  683.           $ref: '#/definitions/md.UpdateAdminStateReq'

  684.       produces:

  685.       - application/json

  686.       responses:

  687.         "200":

  688.           description: success

  689.           schema:

  690.             type: string

  691.         "400":

  692.           description: 具体错误

  693.           schema:

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

  695.       summary: 修改管理员状态

  696.       tags:

  697.       - 权限管理

  698.   /api/role/updateRole:

  699.     post:

  700.       consumes:

  701.       - application/json

  702.       description: 权限管理-修改角色状态

  703.       parameters:

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

  705.         in: header

  706.         name: Authorization

  707.         required: true

  708.         type: string

  709.       - description: 请求参数

  710.         in: body

  711.         name: args

  712.         required: true

  713.         schema:

  714.           $ref: '#/definitions/md.UpdateRoleStateReq'

  715.       produces:

  716.       - application/json

  717.       responses:

  718.         "200":

  719.           description: success

  720.           schema:

  721.             type: string

  722.         "400":

  723.           description: 具体错误

  724.           schema:

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

  726.       summary: 修改角色状态

  727.       tags:

  728.       - 权限管理

  729. securityDefinitions:

  730.   MasterID:

  731.     in: header

  732.     name: MasterID

  733.     type: apiKey

  734. swagger: "2.0"