zhimeng
/
agent_ad
2
0
Förgrening 0
Kod Ärenden 0 Pull-förfrågningar 0 Släpp 0 Wiki Aktiviteter
广告平台(站长下代理使用)
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
10 Incheckningar
1 Gren
607 KiB
 
 
 
 
 
 
Träd: 108e20f6dc
Grenar Taggar
${ item.name }
Skapa branchen ${ searchTerm }
från '108e20f6dc'
${ noResults }
agent_ad/docs/swagger.yaml

805 rader
18 KiB
Rå Blame Historik 

  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.AgentBankInfo:

  36.     properties:

  37.       agent_id:

  38.         type: integer

  39.       bank:

  40.         type: string

  41.       bank_branch:

  42.         type: string

  43.       bank_no:

  44.         type: string

  45.       currency_conf:

  46.         type: integer

  47.       id:

  48.         type: integer

  49.       licence:

  50.         type: string

  51.       memo:

  52.         type: string

  53.       state:

  54.         type: integer

  55.       uuid:

  56.         type: integer

  57.     type: object

  58.   md.AgentContactInfo:

  59.     properties:

  60.       address:

  61.         type: string

  62.       agent_id:

  63.         type: integer

  64.       email:

  65.         type: string

  66.       id:

  67.         type: integer

  68.       memo:

  69.         type: string

  70.       name:

  71.         type: string

  72.       phone:

  73.         type: string

  74.       state:

  75.         type: integer

  76.       uuid:

  77.         type: integer

  78.     type: object

  79.   md.AgentList:

  80.     properties:

  81.       agent_id:

  82.         type: integer

  83.       business_license_address:

  84.         type: string

  85.       business_license_img_url:

  86.         type: string

  87.       certificate_first_type:

  88.         type: integer

  89.       certificate_type:

  90.         type: integer

  91.       certificate_validity:

  92.         type: string

  93.       company_abbreviation:

  94.         type: string

  95.       company_name:

  96.         type: string

  97.       country_region:

  98.         type: string

  99.       country_region_id:

  100.         type: integer

  101.       id:

  102.         type: integer

  103.       kind:

  104.         type: integer

  105.       legal_representative:

  106.         type: string

  107.       memo:

  108.         type: string

  109.       registered_address:

  110.         type: string

  111.       registered_address_city_id:

  112.         type: integer

  113.       registered_address_country_id:

  114.         type: integer

  115.       registered_address_county_id:

  116.         type: integer

  117.       registered_address_province_id:

  118.         type: integer

  119.       state:

  120.         type: integer

  121.       unified_social_credit_code:

  122.         type: string

  123.       uuid:

  124.         type: integer

  125.     type: object

  126.   md.BindAdminRoleReq:

  127.     properties:

  128.       id:

  129.         type: integer

  130.       role_ids:

  131.         items:

  132.           type: integer

  133.         type: array

  134.     required:

  135.     - id

  136.     type: object

  137.   md.LoginReq:

  138.     properties:

  139.       code:

  140.         example: 验证码

  141.         type: string

  142.       password:

  143.         example: 登录密码

  144.         type: string

  145.       username:

  146.         example: 登录账号

  147.         type: string

  148.     required:

  149.     - password

  150.     - username

  151.     type: object

  152.   md.LoginResponse:

  153.     properties:

  154.       token:

  155.         type: string

  156.     type: object

  157.   md.Response:

  158.     properties:

  159.       code:

  160.         example: 响应码

  161.         type: string

  162.       data:

  163.         description: 内容

  164.       msg:

  165.         example: 具体错误原因

  166.         type: string

  167.     type: object

  168.   md.RoleBindPermissionGroupReq:

  169.     properties:

  170.       permission_ids:

  171.         items:

  172.           type: integer

  173.         type: array

  174.       role_id:

  175.         type: integer

  176.     required:

  177.     - role_id

  178.     type: object

  179.   md.UpdateAdminReq:

  180.     properties:

  181.       id:

  182.         type: integer

  183.       memo:

  184.         type: string

  185.       password:

  186.         type: string

  187.       username:

  188.         type: string

  189.     required:

  190.     - id

  191.     - password

  192.     - username

  193.     type: object

  194.   md.UpdateAdminStateReq:

  195.     properties:

  196.       id:

  197.         type: integer

  198.       state:

  199.         type: integer

  200.     required:

  201.     - id

  202.     - state

  203.     type: object

  204.   md.UpdateRoleReq:

  205.     properties:

  206.       memo:

  207.         type: string

  208.       name:

  209.         type: string

  210.       role_id:

  211.         type: integer

  212.     required:

  213.     - memo

  214.     - name

  215.     - role_id

  216.     type: object

  217.   md.UpdateRoleStateReq:

  218.     properties:

  219.       role_id:

  220.         type: integer

  221.       state:

  222.         type: integer

  223.     required:

  224.     - role_id

  225.     - state

  226.     type: object

  227. host: localhost:1003 or advertisement.dengbiao.top

  228. info:

  229.   contact:

  230.     email: 1239118001@qq.com

  231.     name: dengbiao

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

  233.   description: 渠道代理后台接口

  234.   license:

  235.     name: Apache 2.0

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

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

  238.   title: 广告联盟-渠道代理平台

  239.   version: "1.0"

  240. paths:

  241.   /api/login:

  242.     post:

  243.       consumes:

  244.       - application/json

  245.       description: 登入

  246.       parameters:

  247.       - description: 用户名密码

  248.         in: body

  249.         name: req

  250.         required: true

  251.         schema:

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

  253.       produces:

  254.       - application/json

  255.       responses:

  256.         "200":

  257.           description: token

  258.           schema:

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

  260.         "400":

  261.           description: 具体错误

  262.           schema:

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

  264.       summary: 登陆

  265.       tags:

  266.       - ADMIN

  267.   /api/qualification/bank/save:

  268.     post:

  269.       consumes:

  270.       - application/json

  271.       description: 资质认证-银行资质保存

  272.       parameters:

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

  274.         in: header

  275.         name: Authorization

  276.         required: true

  277.         type: string

  278.       - description: 请求参数

  279.         in: body

  280.         name: args

  281.         required: true

  282.         schema:

  283.           $ref: '#/definitions/md.AgentBankInfo'

  284.       produces:

  285.       - application/json

  286.       responses:

  287.         "200":

  288.           description: 具体看返回内容

  289.           schema:

  290.             type: string

  291.         "400":

  292.           description: 具体错误

  293.           schema:

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

  295.       summary: 银行资质保存

  296.       tags:

  297.       - 资质认证------嘉俊

  298.   /api/qualification/contact/save:

  299.     post:

  300.       consumes:

  301.       - application/json

  302.       description: 资质认证-联系方式保存

  303.       parameters:

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

  305.         in: header

  306.         name: Authorization

  307.         required: true

  308.         type: string

  309.       - description: 请求参数

  310.         in: body

  311.         name: args

  312.         required: true

  313.         schema:

  314.           $ref: '#/definitions/md.AgentContactInfo'

  315.       produces:

  316.       - application/json

  317.       responses:

  318.         "200":

  319.           description: 具体看返回内容

  320.           schema:

  321.             type: string

  322.         "400":

  323.           description: 具体错误

  324.           schema:

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

  326.       summary: 联系方式保存

  327.       tags:

  328.       - 资质认证------嘉俊

  329.   /api/qualification/enterprise/save:

  330.     post:

  331.       consumes:

  332.       - application/json

  333.       description: 资质认证-企业认证保存

  334.       parameters:

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

  336.         in: header

  337.         name: Authorization

  338.         required: true

  339.         type: string

  340.       - description: 请求参数

  341.         in: body

  342.         name: args

  343.         required: true

  344.         schema:

  345.           $ref: '#/definitions/md.AgentList'

  346.       produces:

  347.       - application/json

  348.       responses:

  349.         "200":

  350.           description: 具体看返回内容

  351.           schema:

  352.             type: string

  353.         "400":

  354.           description: 具体错误

  355.           schema:

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

  357.       summary: 企业认证保存

  358.       tags:

  359.       - 资质认证------嘉俊

  360.   /api/qualification/info:

  361.     get:

  362.       consumes:

  363.       - application/json

  364.       description: 资质认证-基本信息

  365.       parameters:

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

  367.         in: header

  368.         name: Authorization

  369.         required: true

  370.         type: string

  371.       produces:

  372.       - application/json

  373.       responses:

  374.         "200":

  375.           description: 具体看返回内容

  376.           schema:

  377.             type: string

  378.         "400":

  379.           description: 具体错误

  380.           schema:

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

  382.       summary: 基本信息

  383.       tags:

  384.       - 资质认证------嘉俊

  385.   /api/qualification/select/base:

  386.     get:

  387.       consumes:

  388.       - application/json

  389.       description: 资质认证-认证下拉框选择内容

  390.       parameters:

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

  392.         in: header

  393.         name: Authorization

  394.         required: true

  395.         type: string

  396.       produces:

  397.       - application/json

  398.       responses:

  399.         "200":

  400.           description: 具体看返回内容

  401.           schema:

  402.             type: string

  403.         "400":

  404.           description: 具体错误

  405.           schema:

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

  407.       summary: 认证下拉框选择内容

  408.       tags:

  409.       - 资质认证------嘉俊

  410.   /api/role/addAdmin:

  411.     post:

  412.       consumes:

  413.       - application/json

  414.       description: 新增管理员

  415.       parameters:

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

  417.         in: header

  418.         name: Authorization

  419.         required: true

  420.         type: string

  421.       - description: 请求参数

  422.         in: body

  423.         name: args

  424.         required: true

  425.         schema:

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

  427.       produces:

  428.       - application/json

  429.       responses:

  430.         "200":

  431.           description: success

  432.           schema:

  433.             type: string

  434.         "400":

  435.           description: 具体错误

  436.           schema:

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

  438.       summary: 新增管理员

  439.       tags:

  440.       - ADMIN-权限管理

  441.   /api/role/addRole:

  442.     post:

  443.       consumes:

  444.       - application/json

  445.       description: 添加角色

  446.       parameters:

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

  448.         in: header

  449.         name: Authorization

  450.         required: true

  451.         type: string

  452.       - description: 请求参数

  453.         in: body

  454.         name: args

  455.         required: true

  456.         schema:

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

  458.       produces:

  459.       - application/json

  460.       responses:

  461.         "200":

  462.           description: success

  463.           schema:

  464.             type: string

  465.         "400":

  466.           description: 具体错误

  467.           schema:

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

  469.       summary: 添加角色

  470.       tags:

  471.       - ADMIN-权限管理

  472.   /api/role/adminInfo:

  473.     get:

  474.       consumes:

  475.       - application/json

  476.       description: 管理员信息

  477.       parameters:

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

  479.         in: header

  480.         name: Authorization

  481.         required: true

  482.         type: string

  483.       - description: 管理员id

  484.         in: query

  485.         name: adm_id

  486.         required: true

  487.         type: string

  488.       produces:

  489.       - application/json

  490.       responses:

  491.         "200":

  492.           description: 具体看返回内容

  493.           schema:

  494.             type: string

  495.         "400":

  496.           description: 具体错误

  497.           schema:

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

  499.       summary: 管理员信息

  500.       tags:

  501.       - ADMIN-权限管理

  502.   /api/role/adminList:

  503.     post:

  504.       consumes:

  505.       - application/json

  506.       description: 管理员列表

  507.       parameters:

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

  509.         in: header

  510.         name: Authorization

  511.         required: true

  512.         type: string

  513.       - description: 请求参数

  514.         in: body

  515.         name: args

  516.         required: true

  517.         schema:

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

  519.       produces:

  520.       - application/json

  521.       responses:

  522.         "200":

  523.           description: 具体看返回内容

  524.           schema:

  525.             type: string

  526.         "400":

  527.           description: 具体错误

  528.           schema:

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

  530.       summary: 管理员列表

  531.       tags:

  532.       - ADMIN-权限管理

  533.   /api/role/bindAdminRole/:

  534.     post:

  535.       consumes:

  536.       - application/json

  537.       description: 管理员绑定角色

  538.       parameters:

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

  540.         in: header

  541.         name: Authorization

  542.         required: true

  543.         type: string

  544.       - description: 请求参数

  545.         in: body

  546.         name: args

  547.         required: true

  548.         schema:

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

  550.       produces:

  551.       - application/json

  552.       responses:

  553.         "200":

  554.           description: success

  555.           schema:

  556.             type: string

  557.         "400":

  558.           description: 具体错误

  559.           schema:

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

  561.       summary: 管理员绑定角色

  562.       tags:

  563.       - ADMIN-权限管理

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

  565.     delete:

  566.       consumes:

  567.       - application/json

  568.       description: 删除管理员

  569.       parameters:

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

  571.         in: header

  572.         name: Authorization

  573.         required: true

  574.         type: string

  575.       produces:

  576.       - application/json

  577.       responses:

  578.         "200":

  579.           description: success

  580.           schema:

  581.             type: string

  582.         "400":

  583.           description: 具体错误

  584.           schema:

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

  586.       summary: 删除管理员

  587.       tags:

  588.       - ADMIN-权限管理

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

  590.     delete:

  591.       consumes:

  592.       - application/json

  593.       description: 删除角色

  594.       parameters:

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

  596.         in: header

  597.         name: Authorization

  598.         required: true

  599.         type: string

  600.       - description: 请求参数

  601.         in: body

  602.         name: args

  603.         required: true

  604.         schema:

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

  606.       produces:

  607.       - application/json

  608.       responses:

  609.         "200":

  610.           description: success

  611.           schema:

  612.             type: string

  613.         "400":

  614.           description: 具体错误

  615.           schema:

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

  617.       summary: 删除角色

  618.       tags:

  619.       - ADMIN-权限管理

  620.   /api/role/permissionGroupList:

  621.     get:

  622.       consumes:

  623.       - application/json

  624.       description: 权限组列表

  625.       parameters:

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

  627.         in: header

  628.         name: Authorization

  629.         required: true

  630.         type: string

  631.       - description: 管理员id

  632.         in: query

  633.         name: adm_id

  634.         required: true

  635.         type: string

  636.       produces:

  637.       - application/json

  638.       responses:

  639.         "200":

  640.           description: 具体看返回内容

  641.           schema:

  642.             type: string

  643.         "400":

  644.           description: 具体错误

  645.           schema:

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

  647.       summary: 权限组列表

  648.       tags:

  649.       - ADMIN-权限管理

  650.   /api/role/roleBindPermissionGroup:

  651.     post:

  652.       consumes:

  653.       - application/json

  654.       description: 角色绑定权限组

  655.       parameters:

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

  657.         in: header

  658.         name: Authorization

  659.         required: true

  660.         type: string

  661.       - description: 请求参数

  662.         in: body

  663.         name: args

  664.         required: true

  665.         schema:

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

  667.       produces:

  668.       - application/json

  669.       responses:

  670.         "200":

  671.           description: success

  672.           schema:

  673.             type: string

  674.         "400":

  675.           description: 具体错误

  676.           schema:

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

  678.       summary: 角色绑定权限组

  679.       tags:

  680.       - ADMIN-权限管理

  681.   /api/role/roleList:

  682.     get:

  683.       consumes:

  684.       - application/json

  685.       description: 角色列表

  686.       parameters:

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

  688.         in: header

  689.         name: Authorization

  690.         required: true

  691.         type: string

  692.       produces:

  693.       - application/json

  694.       responses:

  695.         "200":

  696.           description: 具体看返回内容

  697.           schema:

  698.             type: string

  699.         "400":

  700.           description: 具体错误

  701.           schema:

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

  703.       summary: 角色列表

  704.       tags:

  705.       - ADMIN-权限管理

  706.   /api/role/updateAdmin:

  707.     post:

  708.       consumes:

  709.       - application/json

  710.       description: 修改管理员信息

  711.       parameters:

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

  713.         in: header

  714.         name: Authorization

  715.         required: true

  716.         type: string

  717.       - description: 请求参数

  718.         in: body

  719.         name: args

  720.         required: true

  721.         schema:

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

  723.       produces:

  724.       - application/json

  725.       responses:

  726.         "200":

  727.           description: success

  728.           schema:

  729.             type: string

  730.         "400":

  731.           description: 具体错误

  732.           schema:

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

  734.       summary: 修改管理员信息

  735.       tags:

  736.       - ADMIN-权限管理

  737.   /api/role/updateAdminState:

  738.     post:

  739.       consumes:

  740.       - application/json

  741.       description: 修改管理员状态

  742.       parameters:

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

  744.         in: header

  745.         name: Authorization

  746.         required: true

  747.         type: string

  748.       - description: 请求参数

  749.         in: body

  750.         name: args

  751.         required: true

  752.         schema:

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

  754.       produces:

  755.       - application/json

  756.       responses:

  757.         "200":

  758.           description: success

  759.           schema:

  760.             type: string

  761.         "400":

  762.           description: 具体错误

  763.           schema:

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

  765.       summary: 修改管理员状态

  766.       tags:

  767.       - ADMIN-权限管理

  768.   /api/role/updateRole:

  769.     post:

  770.       consumes:

  771.       - application/json

  772.       description: 修改角色状态

  773.       parameters:

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

  775.         in: header

  776.         name: Authorization

  777.         required: true

  778.         type: string

  779.       - description: 请求参数

  780.         in: body

  781.         name: args

  782.         required: true

  783.         schema:

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

  785.       produces:

  786.       - application/json

  787.       responses:

  788.         "200":

  789.           description: success

  790.           schema:

  791.             type: string

  792.         "400":

  793.           description: 具体错误

  794.           schema:

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

  796.       summary: 修改角色状态

  797.       tags:

  798.       - ADMIN-权限管理

  799. securityDefinitions:

  800.   MasterID:

  801.     in: header

  802.     name: MasterID

  803.     type: apiKey

  804. swagger: "2.0"