广告平台(站长下代理使用)
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.
 
 
 
 
 
 

1059 lines
34 KiB

  1. {
  2. "swagger": "2.0",
  3. "info": {
  4. "description": "渠道代理后台接口",
  5. "title": "广告联盟-渠道代理平台",
  6. "termsOfService": "http://swagger.io/terms/",
  7. "contact": {
  8. "name": "dengbiao",
  9. "url": "http://www.swagger.io/support",
  10. "email": "1239118001@qq.com"
  11. },
  12. "license": {
  13. "name": "Apache 2.0",
  14. "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
  15. },
  16. "version": "1.0"
  17. },
  18. "host": "localhost:1003 or advertisement.dengbiao.top",
  19. "paths": {
  20. "/api/login": {
  21. "post": {
  22. "description": "登入",
  23. "consumes": [
  24. "application/json"
  25. ],
  26. "produces": [
  27. "application/json"
  28. ],
  29. "tags": [
  30. "ADMIN"
  31. ],
  32. "summary": "登陆",
  33. "parameters": [
  34. {
  35. "description": "用户名密码",
  36. "name": "req",
  37. "in": "body",
  38. "required": true,
  39. "schema": {
  40. "$ref": "#/definitions/md.LoginReq"
  41. }
  42. }
  43. ],
  44. "responses": {
  45. "200": {
  46. "description": "token",
  47. "schema": {
  48. "$ref": "#/definitions/md.LoginResponse"
  49. }
  50. },
  51. "400": {
  52. "description": "具体错误",
  53. "schema": {
  54. "$ref": "#/definitions/md.Response"
  55. }
  56. }
  57. }
  58. }
  59. },
  60. "/api/qualification/enterprise/save": {
  61. "post": {
  62. "description": "资质认证-企业认证保存",
  63. "consumes": [
  64. "application/json"
  65. ],
  66. "produces": [
  67. "application/json"
  68. ],
  69. "tags": [
  70. "资质认证"
  71. ],
  72. "summary": "企业认证保存",
  73. "parameters": [
  74. {
  75. "type": "string",
  76. "description": "验证参数Bearer和token空格拼接",
  77. "name": "Authorization",
  78. "in": "header",
  79. "required": true
  80. },
  81. {
  82. "description": "请求参数",
  83. "name": "args",
  84. "in": "body",
  85. "required": true,
  86. "schema": {
  87. "$ref": "#/definitions/md.AgentList"
  88. }
  89. }
  90. ],
  91. "responses": {
  92. "200": {
  93. "description": "具体看返回内容",
  94. "schema": {
  95. "type": "string"
  96. }
  97. },
  98. "400": {
  99. "description": "具体错误",
  100. "schema": {
  101. "$ref": "#/definitions/md.Response"
  102. }
  103. }
  104. }
  105. }
  106. },
  107. "/api/qualification/info": {
  108. "get": {
  109. "description": "资质认证-基本信息",
  110. "consumes": [
  111. "application/json"
  112. ],
  113. "produces": [
  114. "application/json"
  115. ],
  116. "tags": [
  117. "资质认证"
  118. ],
  119. "summary": "基本信息",
  120. "parameters": [
  121. {
  122. "type": "string",
  123. "description": "验证参数Bearer和token空格拼接",
  124. "name": "Authorization",
  125. "in": "header",
  126. "required": true
  127. }
  128. ],
  129. "responses": {
  130. "200": {
  131. "description": "具体看返回内容",
  132. "schema": {
  133. "type": "string"
  134. }
  135. },
  136. "400": {
  137. "description": "具体错误",
  138. "schema": {
  139. "$ref": "#/definitions/md.Response"
  140. }
  141. }
  142. }
  143. }
  144. },
  145. "/api/qualification/select/base": {
  146. "get": {
  147. "description": "资质认证-认证下拉框选择内容",
  148. "consumes": [
  149. "application/json"
  150. ],
  151. "produces": [
  152. "application/json"
  153. ],
  154. "tags": [
  155. "资质认证"
  156. ],
  157. "summary": "认证下拉框选择内容",
  158. "parameters": [
  159. {
  160. "type": "string",
  161. "description": "验证参数Bearer和token空格拼接",
  162. "name": "Authorization",
  163. "in": "header",
  164. "required": true
  165. }
  166. ],
  167. "responses": {
  168. "200": {
  169. "description": "具体看返回内容",
  170. "schema": {
  171. "type": "string"
  172. }
  173. },
  174. "400": {
  175. "description": "具体错误",
  176. "schema": {
  177. "$ref": "#/definitions/md.Response"
  178. }
  179. }
  180. }
  181. }
  182. },
  183. "/api/role/addAdmin": {
  184. "post": {
  185. "description": "新增管理员",
  186. "consumes": [
  187. "application/json"
  188. ],
  189. "produces": [
  190. "application/json"
  191. ],
  192. "tags": [
  193. "ADMIN-权限管理"
  194. ],
  195. "summary": "新增管理员",
  196. "parameters": [
  197. {
  198. "type": "string",
  199. "description": "验证参数Bearer和token空格拼接",
  200. "name": "Authorization",
  201. "in": "header",
  202. "required": true
  203. },
  204. {
  205. "description": "请求参数",
  206. "name": "args",
  207. "in": "body",
  208. "required": true,
  209. "schema": {
  210. "$ref": "#/definitions/md.AddAdminReq"
  211. }
  212. }
  213. ],
  214. "responses": {
  215. "200": {
  216. "description": "success",
  217. "schema": {
  218. "type": "string"
  219. }
  220. },
  221. "400": {
  222. "description": "具体错误",
  223. "schema": {
  224. "$ref": "#/definitions/md.Response"
  225. }
  226. }
  227. }
  228. }
  229. },
  230. "/api/role/addRole": {
  231. "post": {
  232. "description": "添加角色",
  233. "consumes": [
  234. "application/json"
  235. ],
  236. "produces": [
  237. "application/json"
  238. ],
  239. "tags": [
  240. "ADMIN-权限管理"
  241. ],
  242. "summary": "添加角色",
  243. "parameters": [
  244. {
  245. "type": "string",
  246. "description": "验证参数Bearer和token空格拼接",
  247. "name": "Authorization",
  248. "in": "header",
  249. "required": true
  250. },
  251. {
  252. "description": "请求参数",
  253. "name": "args",
  254. "in": "body",
  255. "required": true,
  256. "schema": {
  257. "$ref": "#/definitions/md.AddRoleReq"
  258. }
  259. }
  260. ],
  261. "responses": {
  262. "200": {
  263. "description": "success",
  264. "schema": {
  265. "type": "string"
  266. }
  267. },
  268. "400": {
  269. "description": "具体错误",
  270. "schema": {
  271. "$ref": "#/definitions/md.Response"
  272. }
  273. }
  274. }
  275. }
  276. },
  277. "/api/role/adminInfo": {
  278. "get": {
  279. "description": "管理员信息",
  280. "consumes": [
  281. "application/json"
  282. ],
  283. "produces": [
  284. "application/json"
  285. ],
  286. "tags": [
  287. "ADMIN-权限管理"
  288. ],
  289. "summary": "管理员信息",
  290. "parameters": [
  291. {
  292. "type": "string",
  293. "description": "验证参数Bearer和token空格拼接",
  294. "name": "Authorization",
  295. "in": "header",
  296. "required": true
  297. },
  298. {
  299. "type": "string",
  300. "description": "管理员id",
  301. "name": "adm_id",
  302. "in": "query",
  303. "required": true
  304. }
  305. ],
  306. "responses": {
  307. "200": {
  308. "description": "具体看返回内容",
  309. "schema": {
  310. "type": "string"
  311. }
  312. },
  313. "400": {
  314. "description": "具体错误",
  315. "schema": {
  316. "$ref": "#/definitions/md.Response"
  317. }
  318. }
  319. }
  320. }
  321. },
  322. "/api/role/adminList": {
  323. "post": {
  324. "description": "管理员列表",
  325. "consumes": [
  326. "application/json"
  327. ],
  328. "produces": [
  329. "application/json"
  330. ],
  331. "tags": [
  332. "ADMIN-权限管理"
  333. ],
  334. "summary": "管理员列表",
  335. "parameters": [
  336. {
  337. "type": "string",
  338. "description": "验证参数Bearer和token空格拼接",
  339. "name": "Authorization",
  340. "in": "header",
  341. "required": true
  342. },
  343. {
  344. "description": "请求参数",
  345. "name": "args",
  346. "in": "body",
  347. "required": true,
  348. "schema": {
  349. "$ref": "#/definitions/md.AdminListReq"
  350. }
  351. }
  352. ],
  353. "responses": {
  354. "200": {
  355. "description": "具体看返回内容",
  356. "schema": {
  357. "type": "string"
  358. }
  359. },
  360. "400": {
  361. "description": "具体错误",
  362. "schema": {
  363. "$ref": "#/definitions/md.Response"
  364. }
  365. }
  366. }
  367. }
  368. },
  369. "/api/role/bindAdminRole/": {
  370. "post": {
  371. "description": "管理员绑定角色",
  372. "consumes": [
  373. "application/json"
  374. ],
  375. "produces": [
  376. "application/json"
  377. ],
  378. "tags": [
  379. "ADMIN-权限管理"
  380. ],
  381. "summary": "管理员绑定角色",
  382. "parameters": [
  383. {
  384. "type": "string",
  385. "description": "验证参数Bearer和token空格拼接",
  386. "name": "Authorization",
  387. "in": "header",
  388. "required": true
  389. },
  390. {
  391. "description": "请求参数",
  392. "name": "args",
  393. "in": "body",
  394. "required": true,
  395. "schema": {
  396. "$ref": "#/definitions/md.BindAdminRoleReq"
  397. }
  398. }
  399. ],
  400. "responses": {
  401. "200": {
  402. "description": "success",
  403. "schema": {
  404. "type": "string"
  405. }
  406. },
  407. "400": {
  408. "description": "具体错误",
  409. "schema": {
  410. "$ref": "#/definitions/md.Response"
  411. }
  412. }
  413. }
  414. }
  415. },
  416. "/api/role/deleteAdmin/{$adm_id}": {
  417. "delete": {
  418. "description": "删除管理员",
  419. "consumes": [
  420. "application/json"
  421. ],
  422. "produces": [
  423. "application/json"
  424. ],
  425. "tags": [
  426. "ADMIN-权限管理"
  427. ],
  428. "summary": "删除管理员",
  429. "parameters": [
  430. {
  431. "type": "string",
  432. "description": "验证参数Bearer和token空格拼接",
  433. "name": "Authorization",
  434. "in": "header",
  435. "required": true
  436. }
  437. ],
  438. "responses": {
  439. "200": {
  440. "description": "success",
  441. "schema": {
  442. "type": "string"
  443. }
  444. },
  445. "400": {
  446. "description": "具体错误",
  447. "schema": {
  448. "$ref": "#/definitions/md.Response"
  449. }
  450. }
  451. }
  452. }
  453. },
  454. "/api/role/deleteRole/{$id}": {
  455. "delete": {
  456. "description": "删除角色",
  457. "consumes": [
  458. "application/json"
  459. ],
  460. "produces": [
  461. "application/json"
  462. ],
  463. "tags": [
  464. "ADMIN-权限管理"
  465. ],
  466. "summary": "删除角色",
  467. "parameters": [
  468. {
  469. "type": "string",
  470. "description": "验证参数Bearer和token空格拼接",
  471. "name": "Authorization",
  472. "in": "header",
  473. "required": true
  474. },
  475. {
  476. "description": "请求参数",
  477. "name": "args",
  478. "in": "body",
  479. "required": true,
  480. "schema": {
  481. "$ref": "#/definitions/md.UpdateRoleStateReq"
  482. }
  483. }
  484. ],
  485. "responses": {
  486. "200": {
  487. "description": "success",
  488. "schema": {
  489. "type": "string"
  490. }
  491. },
  492. "400": {
  493. "description": "具体错误",
  494. "schema": {
  495. "$ref": "#/definitions/md.Response"
  496. }
  497. }
  498. }
  499. }
  500. },
  501. "/api/role/permissionGroupList": {
  502. "get": {
  503. "description": "权限组列表",
  504. "consumes": [
  505. "application/json"
  506. ],
  507. "produces": [
  508. "application/json"
  509. ],
  510. "tags": [
  511. "ADMIN-权限管理"
  512. ],
  513. "summary": "权限组列表",
  514. "parameters": [
  515. {
  516. "type": "string",
  517. "description": "验证参数Bearer和token空格拼接",
  518. "name": "Authorization",
  519. "in": "header",
  520. "required": true
  521. },
  522. {
  523. "type": "string",
  524. "description": "管理员id",
  525. "name": "adm_id",
  526. "in": "query",
  527. "required": true
  528. }
  529. ],
  530. "responses": {
  531. "200": {
  532. "description": "具体看返回内容",
  533. "schema": {
  534. "type": "string"
  535. }
  536. },
  537. "400": {
  538. "description": "具体错误",
  539. "schema": {
  540. "$ref": "#/definitions/md.Response"
  541. }
  542. }
  543. }
  544. }
  545. },
  546. "/api/role/roleBindPermissionGroup": {
  547. "post": {
  548. "description": "角色绑定权限组",
  549. "consumes": [
  550. "application/json"
  551. ],
  552. "produces": [
  553. "application/json"
  554. ],
  555. "tags": [
  556. "ADMIN-权限管理"
  557. ],
  558. "summary": "角色绑定权限组",
  559. "parameters": [
  560. {
  561. "type": "string",
  562. "description": "验证参数Bearer和token空格拼接",
  563. "name": "Authorization",
  564. "in": "header",
  565. "required": true
  566. },
  567. {
  568. "description": "请求参数",
  569. "name": "args",
  570. "in": "body",
  571. "required": true,
  572. "schema": {
  573. "$ref": "#/definitions/md.RoleBindPermissionGroupReq"
  574. }
  575. }
  576. ],
  577. "responses": {
  578. "200": {
  579. "description": "success",
  580. "schema": {
  581. "type": "string"
  582. }
  583. },
  584. "400": {
  585. "description": "具体错误",
  586. "schema": {
  587. "$ref": "#/definitions/md.Response"
  588. }
  589. }
  590. }
  591. }
  592. },
  593. "/api/role/roleList": {
  594. "get": {
  595. "description": "角色列表",
  596. "consumes": [
  597. "application/json"
  598. ],
  599. "produces": [
  600. "application/json"
  601. ],
  602. "tags": [
  603. "ADMIN-权限管理"
  604. ],
  605. "summary": "角色列表",
  606. "parameters": [
  607. {
  608. "type": "string",
  609. "description": "验证参数Bearer和token空格拼接",
  610. "name": "Authorization",
  611. "in": "header",
  612. "required": true
  613. }
  614. ],
  615. "responses": {
  616. "200": {
  617. "description": "具体看返回内容",
  618. "schema": {
  619. "type": "string"
  620. }
  621. },
  622. "400": {
  623. "description": "具体错误",
  624. "schema": {
  625. "$ref": "#/definitions/md.Response"
  626. }
  627. }
  628. }
  629. }
  630. },
  631. "/api/role/updateAdmin": {
  632. "post": {
  633. "description": "修改管理员信息",
  634. "consumes": [
  635. "application/json"
  636. ],
  637. "produces": [
  638. "application/json"
  639. ],
  640. "tags": [
  641. "ADMIN-权限管理"
  642. ],
  643. "summary": "修改管理员信息",
  644. "parameters": [
  645. {
  646. "type": "string",
  647. "description": "验证参数Bearer和token空格拼接",
  648. "name": "Authorization",
  649. "in": "header",
  650. "required": true
  651. },
  652. {
  653. "description": "请求参数",
  654. "name": "args",
  655. "in": "body",
  656. "required": true,
  657. "schema": {
  658. "$ref": "#/definitions/md.UpdateAdminReq"
  659. }
  660. }
  661. ],
  662. "responses": {
  663. "200": {
  664. "description": "success",
  665. "schema": {
  666. "type": "string"
  667. }
  668. },
  669. "400": {
  670. "description": "具体错误",
  671. "schema": {
  672. "$ref": "#/definitions/md.Response"
  673. }
  674. }
  675. }
  676. }
  677. },
  678. "/api/role/updateAdminState": {
  679. "post": {
  680. "description": "修改管理员状态",
  681. "consumes": [
  682. "application/json"
  683. ],
  684. "produces": [
  685. "application/json"
  686. ],
  687. "tags": [
  688. "ADMIN-权限管理"
  689. ],
  690. "summary": "修改管理员状态",
  691. "parameters": [
  692. {
  693. "type": "string",
  694. "description": "验证参数Bearer和token空格拼接",
  695. "name": "Authorization",
  696. "in": "header",
  697. "required": true
  698. },
  699. {
  700. "description": "请求参数",
  701. "name": "args",
  702. "in": "body",
  703. "required": true,
  704. "schema": {
  705. "$ref": "#/definitions/md.UpdateAdminStateReq"
  706. }
  707. }
  708. ],
  709. "responses": {
  710. "200": {
  711. "description": "success",
  712. "schema": {
  713. "type": "string"
  714. }
  715. },
  716. "400": {
  717. "description": "具体错误",
  718. "schema": {
  719. "$ref": "#/definitions/md.Response"
  720. }
  721. }
  722. }
  723. }
  724. },
  725. "/api/role/updateRole": {
  726. "post": {
  727. "description": "修改角色状态",
  728. "consumes": [
  729. "application/json"
  730. ],
  731. "produces": [
  732. "application/json"
  733. ],
  734. "tags": [
  735. "ADMIN-权限管理"
  736. ],
  737. "summary": "修改角色状态",
  738. "parameters": [
  739. {
  740. "type": "string",
  741. "description": "验证参数Bearer和token空格拼接",
  742. "name": "Authorization",
  743. "in": "header",
  744. "required": true
  745. },
  746. {
  747. "description": "请求参数",
  748. "name": "args",
  749. "in": "body",
  750. "required": true,
  751. "schema": {
  752. "$ref": "#/definitions/md.UpdateRoleStateReq"
  753. }
  754. }
  755. ],
  756. "responses": {
  757. "200": {
  758. "description": "success",
  759. "schema": {
  760. "type": "string"
  761. }
  762. },
  763. "400": {
  764. "description": "具体错误",
  765. "schema": {
  766. "$ref": "#/definitions/md.Response"
  767. }
  768. }
  769. }
  770. }
  771. }
  772. },
  773. "definitions": {
  774. "md.AddAdminReq": {
  775. "type": "object",
  776. "required": [
  777. "password",
  778. "username"
  779. ],
  780. "properties": {
  781. "memo": {
  782. "type": "string"
  783. },
  784. "password": {
  785. "type": "string"
  786. },
  787. "username": {
  788. "type": "string"
  789. }
  790. }
  791. },
  792. "md.AddRoleReq": {
  793. "type": "object",
  794. "required": [
  795. "memo",
  796. "name"
  797. ],
  798. "properties": {
  799. "memo": {
  800. "type": "string"
  801. },
  802. "name": {
  803. "type": "string"
  804. }
  805. }
  806. },
  807. "md.AdminListReq": {
  808. "type": "object",
  809. "properties": {
  810. "limit": {
  811. "type": "integer"
  812. },
  813. "page": {
  814. "type": "integer"
  815. },
  816. "state": {
  817. "type": "integer"
  818. },
  819. "username": {
  820. "type": "string"
  821. }
  822. }
  823. },
  824. "md.AgentList": {
  825. "type": "object",
  826. "properties": {
  827. "agent_id": {
  828. "type": "integer"
  829. },
  830. "business_license_address": {
  831. "type": "string"
  832. },
  833. "business_license_img_url": {
  834. "type": "string"
  835. },
  836. "certificate_first_type": {
  837. "type": "integer"
  838. },
  839. "certificate_type": {
  840. "type": "integer"
  841. },
  842. "certificate_validity": {
  843. "type": "string"
  844. },
  845. "company_abbreviation": {
  846. "type": "string"
  847. },
  848. "company_name": {
  849. "type": "string"
  850. },
  851. "country_region": {
  852. "type": "string"
  853. },
  854. "country_region_id": {
  855. "type": "integer"
  856. },
  857. "create_at": {
  858. "type": "string"
  859. },
  860. "id": {
  861. "type": "integer"
  862. },
  863. "kind": {
  864. "type": "integer"
  865. },
  866. "legal_representative": {
  867. "type": "string"
  868. },
  869. "memo": {
  870. "type": "string"
  871. },
  872. "registered_address": {
  873. "type": "string"
  874. },
  875. "registered_address_city_id": {
  876. "type": "integer"
  877. },
  878. "registered_address_country_id": {
  879. "type": "integer"
  880. },
  881. "registered_address_county_id": {
  882. "type": "integer"
  883. },
  884. "registered_address_province_id": {
  885. "type": "integer"
  886. },
  887. "state": {
  888. "type": "integer"
  889. },
  890. "unified_social_credit_code": {
  891. "type": "string"
  892. },
  893. "update_at": {
  894. "type": "string"
  895. },
  896. "uuid": {
  897. "type": "integer"
  898. }
  899. }
  900. },
  901. "md.BindAdminRoleReq": {
  902. "type": "object",
  903. "required": [
  904. "id"
  905. ],
  906. "properties": {
  907. "id": {
  908. "type": "integer"
  909. },
  910. "role_ids": {
  911. "type": "array",
  912. "items": {
  913. "type": "integer"
  914. }
  915. }
  916. }
  917. },
  918. "md.LoginReq": {
  919. "type": "object",
  920. "required": [
  921. "password",
  922. "username"
  923. ],
  924. "properties": {
  925. "code": {
  926. "type": "string",
  927. "example": "验证码"
  928. },
  929. "password": {
  930. "type": "string",
  931. "example": "登录密码"
  932. },
  933. "username": {
  934. "type": "string",
  935. "example": "登录账号"
  936. }
  937. }
  938. },
  939. "md.LoginResponse": {
  940. "type": "object",
  941. "properties": {
  942. "token": {
  943. "type": "string"
  944. }
  945. }
  946. },
  947. "md.Response": {
  948. "type": "object",
  949. "properties": {
  950. "code": {
  951. "type": "string",
  952. "example": "响应码"
  953. },
  954. "data": {
  955. "description": "内容"
  956. },
  957. "msg": {
  958. "type": "string",
  959. "example": "具体错误原因"
  960. }
  961. }
  962. },
  963. "md.RoleBindPermissionGroupReq": {
  964. "type": "object",
  965. "required": [
  966. "role_id"
  967. ],
  968. "properties": {
  969. "permission_ids": {
  970. "type": "array",
  971. "items": {
  972. "type": "integer"
  973. }
  974. },
  975. "role_id": {
  976. "type": "integer"
  977. }
  978. }
  979. },
  980. "md.UpdateAdminReq": {
  981. "type": "object",
  982. "required": [
  983. "id",
  984. "password",
  985. "username"
  986. ],
  987. "properties": {
  988. "id": {
  989. "type": "integer"
  990. },
  991. "memo": {
  992. "type": "string"
  993. },
  994. "password": {
  995. "type": "string"
  996. },
  997. "username": {
  998. "type": "string"
  999. }
  1000. }
  1001. },
  1002. "md.UpdateAdminStateReq": {
  1003. "type": "object",
  1004. "required": [
  1005. "id",
  1006. "state"
  1007. ],
  1008. "properties": {
  1009. "id": {
  1010. "type": "integer"
  1011. },
  1012. "state": {
  1013. "type": "integer"
  1014. }
  1015. }
  1016. },
  1017. "md.UpdateRoleReq": {
  1018. "type": "object",
  1019. "required": [
  1020. "memo",
  1021. "name",
  1022. "role_id"
  1023. ],
  1024. "properties": {
  1025. "memo": {
  1026. "type": "string"
  1027. },
  1028. "name": {
  1029. "type": "string"
  1030. },
  1031. "role_id": {
  1032. "type": "integer"
  1033. }
  1034. }
  1035. },
  1036. "md.UpdateRoleStateReq": {
  1037. "type": "object",
  1038. "required": [
  1039. "role_id",
  1040. "state"
  1041. ],
  1042. "properties": {
  1043. "role_id": {
  1044. "type": "integer"
  1045. },
  1046. "state": {
  1047. "type": "integer"
  1048. }
  1049. }
  1050. }
  1051. },
  1052. "securityDefinitions": {
  1053. "MasterID": {
  1054. "type": "apiKey",
  1055. "name": "MasterID",
  1056. "in": "header"
  1057. }
  1058. }
  1059. }