/internal/app/swagger/swagger.yaml

https://github.com/LyricTian/gin-admin · YAML · 1583 lines · 1583 code · 0 blank · 0 comment · 0 complexity · 0e94f884d6389d8e2760360df08966fd MD5 · raw file

  1. basePath: /
  2. definitions:
  3. schema.Demo:
  4. properties:
  5. code:
  6. description: 编号
  7. type: string
  8. created_at:
  9. description: 创建时间
  10. type: string
  11. creator:
  12. description: 创建者
  13. type: string
  14. id:
  15. description: 唯一标识
  16. type: string
  17. memo:
  18. description: 备注
  19. type: string
  20. name:
  21. description: 名称
  22. type: string
  23. status:
  24. description: 状态(1:启用 2:停用)
  25. type: integer
  26. updated_at:
  27. description: 更新时间
  28. type: string
  29. required:
  30. - code
  31. - name
  32. - status
  33. type: object
  34. schema.ErrorItem:
  35. properties:
  36. code:
  37. description: 错误码
  38. type: integer
  39. message:
  40. description: 错误信息
  41. type: string
  42. type: object
  43. schema.ErrorResult:
  44. properties:
  45. error:
  46. $ref: '#/definitions/schema.ErrorItem'
  47. description: 错误项
  48. type: object
  49. type: object
  50. schema.IDResult:
  51. properties:
  52. id:
  53. type: string
  54. type: object
  55. schema.ListResult:
  56. properties:
  57. list:
  58. type: object
  59. pagination:
  60. $ref: '#/definitions/schema.PaginationResult'
  61. type: object
  62. type: object
  63. schema.LoginCaptcha:
  64. properties:
  65. captcha_id:
  66. description: 验证码ID
  67. type: string
  68. type: object
  69. schema.LoginParam:
  70. properties:
  71. captcha_code:
  72. description: 验证码
  73. type: string
  74. captcha_id:
  75. description: 验证码ID
  76. type: string
  77. password:
  78. description: 密码(md5加密)
  79. type: string
  80. user_name:
  81. description: 用户名
  82. type: string
  83. required:
  84. - captcha_code
  85. - captcha_id
  86. - password
  87. - user_name
  88. type: object
  89. schema.LoginTokenInfo:
  90. properties:
  91. access_token:
  92. description: 访问令牌
  93. type: string
  94. expires_at:
  95. description: 令牌到期时间戳
  96. type: integer
  97. token_type:
  98. description: 令牌类型
  99. type: string
  100. type: object
  101. schema.Menu:
  102. properties:
  103. actions:
  104. $ref: '#/definitions/schema.MenuActions'
  105. description: 动作列表
  106. type: object
  107. created_at:
  108. description: 创建时间
  109. type: string
  110. creator:
  111. description: 创建者
  112. type: string
  113. icon:
  114. description: 菜单图标
  115. type: string
  116. id:
  117. description: 唯一标识
  118. type: string
  119. memo:
  120. description: 备注
  121. type: string
  122. name:
  123. description: 菜单名称
  124. type: string
  125. parent_id:
  126. description: 父级ID
  127. type: string
  128. parent_path:
  129. description: 父级路径
  130. type: string
  131. router:
  132. description: 访问路由
  133. type: string
  134. sequence:
  135. description: 排序值
  136. type: integer
  137. show_status:
  138. description: 显示状态(1:显示 2:隐藏)
  139. type: integer
  140. status:
  141. description: 状态(1:启用 2:禁用)
  142. type: integer
  143. updated_at:
  144. description: 更新时间
  145. type: string
  146. required:
  147. - name
  148. - show_status
  149. - status
  150. type: object
  151. schema.MenuAction:
  152. properties:
  153. code:
  154. description: 动作编号
  155. type: string
  156. id:
  157. description: 唯一标识
  158. type: string
  159. menu_id:
  160. description: 菜单ID
  161. type: string
  162. name:
  163. description: 动作名称
  164. type: string
  165. resources:
  166. $ref: '#/definitions/schema.MenuActionResources'
  167. description: 资源列表
  168. type: object
  169. required:
  170. - code
  171. - menu_id
  172. - name
  173. type: object
  174. schema.MenuActionResource:
  175. properties:
  176. action_id:
  177. description: 菜单动作ID
  178. type: string
  179. id:
  180. description: 唯一标识
  181. type: string
  182. method:
  183. description: 资源请求方式(支持正则)
  184. type: string
  185. path:
  186. description: 资源请求路径支持/:id匹配
  187. type: string
  188. required:
  189. - method
  190. - path
  191. type: object
  192. schema.MenuActionResources:
  193. items:
  194. $ref: '#/definitions/schema.MenuActionResource'
  195. type: array
  196. schema.MenuActions:
  197. items:
  198. $ref: '#/definitions/schema.MenuAction'
  199. type: array
  200. schema.MenuTree:
  201. properties:
  202. actions:
  203. $ref: '#/definitions/schema.MenuActions'
  204. description: 动作列表
  205. type: object
  206. children:
  207. $ref: '#/definitions/schema.MenuTrees'
  208. description: 子级树
  209. type: object
  210. icon:
  211. description: 菜单图标
  212. type: string
  213. id:
  214. description: 唯一标识
  215. type: string
  216. name:
  217. description: 菜单名称
  218. type: string
  219. parent_id:
  220. description: 父级ID
  221. type: string
  222. parent_path:
  223. description: 父级路径
  224. type: string
  225. router:
  226. description: 访问路由
  227. type: string
  228. sequence:
  229. description: 排序值
  230. type: integer
  231. show_status:
  232. description: 显示状态(1:显示 2:隐藏)
  233. type: integer
  234. status:
  235. description: 状态(1:启用 2:禁用)
  236. type: integer
  237. type: object
  238. schema.MenuTrees:
  239. items:
  240. $ref: '#/definitions/schema.MenuTree'
  241. type: array
  242. schema.PaginationResult:
  243. properties:
  244. current:
  245. type: integer
  246. pageSize:
  247. type: integer
  248. total:
  249. type: integer
  250. type: object
  251. schema.Role:
  252. properties:
  253. created_at:
  254. description: 创建时间
  255. type: string
  256. creator:
  257. description: 创建者
  258. type: string
  259. id:
  260. description: 唯一标识
  261. type: string
  262. memo:
  263. description: 备注
  264. type: string
  265. name:
  266. description: 角色名称
  267. type: string
  268. role_menus:
  269. $ref: '#/definitions/schema.RoleMenus'
  270. description: 角色菜单列表
  271. type: object
  272. sequence:
  273. description: 排序值
  274. type: integer
  275. status:
  276. description: 状态(1:启用 2:禁用)
  277. type: integer
  278. updated_at:
  279. description: 更新时间
  280. type: string
  281. required:
  282. - name
  283. - role_menus
  284. - status
  285. type: object
  286. schema.RoleMenu:
  287. properties:
  288. action_id:
  289. description: 动作ID
  290. type: string
  291. id:
  292. description: 唯一标识
  293. type: string
  294. menu_id:
  295. description: 菜单ID
  296. type: string
  297. role_id:
  298. description: 角色ID
  299. type: string
  300. required:
  301. - action_id
  302. - menu_id
  303. - role_id
  304. type: object
  305. schema.RoleMenus:
  306. items:
  307. $ref: '#/definitions/schema.RoleMenu'
  308. type: array
  309. schema.Roles:
  310. items:
  311. $ref: '#/definitions/schema.Role'
  312. type: array
  313. schema.StatusResult:
  314. properties:
  315. status:
  316. description: 状态(OK)
  317. type: string
  318. type: object
  319. schema.UpdatePasswordParam:
  320. properties:
  321. new_password:
  322. description: 新密码(md5加密)
  323. type: string
  324. old_password:
  325. description: 旧密码(md5加密)
  326. type: string
  327. required:
  328. - new_password
  329. - old_password
  330. type: object
  331. schema.User:
  332. properties:
  333. created_at:
  334. description: 创建时间
  335. type: string
  336. creator:
  337. description: 创建者
  338. type: string
  339. email:
  340. description: 邮箱
  341. type: string
  342. id:
  343. description: 唯一标识
  344. type: string
  345. password:
  346. description: 密码
  347. type: string
  348. phone:
  349. description: 手机号
  350. type: string
  351. real_name:
  352. description: 真实姓名
  353. type: string
  354. status:
  355. description: 用户状态(1:启用 2:停用)
  356. type: integer
  357. user_name:
  358. description: 用户名
  359. type: string
  360. user_roles:
  361. $ref: '#/definitions/schema.UserRoles'
  362. description: 角色授权
  363. type: object
  364. required:
  365. - real_name
  366. - status
  367. - user_name
  368. - user_roles
  369. type: object
  370. schema.UserLoginInfo:
  371. properties:
  372. real_name:
  373. description: 真实姓名
  374. type: string
  375. roles:
  376. $ref: '#/definitions/schema.Roles'
  377. description: 角色列表
  378. type: object
  379. user_id:
  380. description: 用户ID
  381. type: string
  382. user_name:
  383. description: 用户名
  384. type: string
  385. type: object
  386. schema.UserRole:
  387. properties:
  388. id:
  389. description: 唯一标识
  390. type: string
  391. role_id:
  392. description: 角色ID
  393. type: string
  394. user_id:
  395. description: 用户ID
  396. type: string
  397. type: object
  398. schema.UserRoles:
  399. items:
  400. $ref: '#/definitions/schema.UserRole'
  401. type: array
  402. schema.UserShow:
  403. properties:
  404. created_at:
  405. description: 创建时间
  406. type: string
  407. email:
  408. description: 邮箱
  409. type: string
  410. id:
  411. description: 唯一标识
  412. type: string
  413. phone:
  414. description: 手机号
  415. type: string
  416. real_name:
  417. description: 真实姓名
  418. type: string
  419. roles:
  420. description: 授权角色列表
  421. items:
  422. $ref: '#/definitions/schema.Role'
  423. type: array
  424. status:
  425. description: 用户状态(1:启用 2:停用)
  426. type: integer
  427. user_name:
  428. description: 用户名
  429. type: string
  430. type: object
  431. info:
  432. contact:
  433. email: tiannianshou@gmail.com
  434. name: LyricTian
  435. description: RBAC scaffolding based on GIN + GORM + CASBIN + WIRE.
  436. license: {}
  437. title: gin-admin
  438. version: 7.0.0
  439. paths:
  440. /api/v1/demos:
  441. get:
  442. parameters:
  443. - default: 1
  444. description: 分页索引
  445. in: query
  446. name: current
  447. required: true
  448. type: integer
  449. - default: 10
  450. description: 分页大小
  451. in: query
  452. name: pageSize
  453. required: true
  454. type: integer
  455. - description: 查询值
  456. in: query
  457. name: queryValue
  458. type: string
  459. responses:
  460. "200":
  461. description: 查询结果
  462. schema:
  463. allOf:
  464. - $ref: '#/definitions/schema.ListResult'
  465. - properties:
  466. list:
  467. items:
  468. $ref: '#/definitions/schema.Demo'
  469. type: array
  470. type: object
  471. "401":
  472. description: '{error:{code:0,message:未授权}}'
  473. schema:
  474. $ref: '#/definitions/schema.ErrorResult'
  475. "500":
  476. description: '{error:{code:0,message:服务器错误}}'
  477. schema:
  478. $ref: '#/definitions/schema.ErrorResult'
  479. security:
  480. - ApiKeyAuth: []
  481. summary: 查询数据
  482. tags:
  483. - Demo
  484. post:
  485. parameters:
  486. - description: 创建数据
  487. in: body
  488. name: body
  489. required: true
  490. schema:
  491. $ref: '#/definitions/schema.Demo'
  492. responses:
  493. "200":
  494. description: OK
  495. schema:
  496. $ref: '#/definitions/schema.IDResult'
  497. "400":
  498. description: '{error:{code:0,message:无效的请求参数}}'
  499. schema:
  500. $ref: '#/definitions/schema.ErrorResult'
  501. "401":
  502. description: '{error:{code:0,message:未授权}}'
  503. schema:
  504. $ref: '#/definitions/schema.ErrorResult'
  505. "500":
  506. description: '{error:{code:0,message:服务器错误}}'
  507. schema:
  508. $ref: '#/definitions/schema.ErrorResult'
  509. security:
  510. - ApiKeyAuth: []
  511. summary: 创建数据
  512. tags:
  513. - Demo
  514. /api/v1/demos/{id}:
  515. delete:
  516. parameters:
  517. - description: 唯一标识
  518. in: path
  519. name: id
  520. required: true
  521. type: string
  522. responses:
  523. "200":
  524. description: '{status:OK}'
  525. schema:
  526. $ref: '#/definitions/schema.StatusResult'
  527. "401":
  528. description: '{error:{code:0,message:未授权}}'
  529. schema:
  530. $ref: '#/definitions/schema.ErrorResult'
  531. "500":
  532. description: '{error:{code:0,message:服务器错误}}'
  533. schema:
  534. $ref: '#/definitions/schema.ErrorResult'
  535. security:
  536. - ApiKeyAuth: []
  537. summary: 删除数据
  538. tags:
  539. - Demo
  540. get:
  541. parameters:
  542. - description: 唯一标识
  543. in: path
  544. name: id
  545. required: true
  546. type: string
  547. responses:
  548. "200":
  549. description: OK
  550. schema:
  551. $ref: '#/definitions/schema.Demo'
  552. "401":
  553. description: '{error:{code:0,message:未授权}}'
  554. schema:
  555. $ref: '#/definitions/schema.ErrorResult'
  556. "404":
  557. description: '{error:{code:0,message:资源不存在}}'
  558. schema:
  559. $ref: '#/definitions/schema.ErrorResult'
  560. "500":
  561. description: '{error:{code:0,message:服务器错误}}'
  562. schema:
  563. $ref: '#/definitions/schema.ErrorResult'
  564. security:
  565. - ApiKeyAuth: []
  566. summary: 查询指定数据
  567. tags:
  568. - Demo
  569. put:
  570. parameters:
  571. - description: 唯一标识
  572. in: path
  573. name: id
  574. required: true
  575. type: string
  576. - description: 更新数据
  577. in: body
  578. name: body
  579. required: true
  580. schema:
  581. $ref: '#/definitions/schema.Demo'
  582. responses:
  583. "200":
  584. description: '{status:OK}'
  585. schema:
  586. $ref: '#/definitions/schema.StatusResult'
  587. "400":
  588. description: '{error:{code:0,message:无效的请求参数}}'
  589. schema:
  590. $ref: '#/definitions/schema.ErrorResult'
  591. "401":
  592. description: '{error:{code:0,message:未授权}}'
  593. schema:
  594. $ref: '#/definitions/schema.ErrorResult'
  595. "500":
  596. description: '{error:{code:0,message:服务器错误}}'
  597. schema:
  598. $ref: '#/definitions/schema.ErrorResult'
  599. security:
  600. - ApiKeyAuth: []
  601. summary: 更新数据
  602. tags:
  603. - Demo
  604. /api/v1/demos/{id}/disable:
  605. patch:
  606. parameters:
  607. - description: 唯一标识
  608. in: path
  609. name: id
  610. required: true
  611. type: string
  612. responses:
  613. "200":
  614. description: '{status:OK}'
  615. schema:
  616. $ref: '#/definitions/schema.StatusResult'
  617. "401":
  618. description: '{error:{code:0,message:未授权}}'
  619. schema:
  620. $ref: '#/definitions/schema.ErrorResult'
  621. "500":
  622. description: '{error:{code:0,message:服务器错误}}'
  623. schema:
  624. $ref: '#/definitions/schema.ErrorResult'
  625. security:
  626. - ApiKeyAuth: []
  627. summary: 禁用数据
  628. tags:
  629. - Demo
  630. /api/v1/demos/{id}/enable:
  631. patch:
  632. parameters:
  633. - description: 唯一标识
  634. in: path
  635. name: id
  636. required: true
  637. type: string
  638. responses:
  639. "200":
  640. description: '{status:OK}'
  641. schema:
  642. $ref: '#/definitions/schema.StatusResult'
  643. "401":
  644. description: '{error:{code:0,message:未授权}}'
  645. schema:
  646. $ref: '#/definitions/schema.ErrorResult'
  647. "500":
  648. description: '{error:{code:0,message:服务器错误}}'
  649. schema:
  650. $ref: '#/definitions/schema.ErrorResult'
  651. security:
  652. - ApiKeyAuth: []
  653. summary: 启用数据
  654. tags:
  655. - Demo
  656. /api/v1/menus:
  657. get:
  658. parameters:
  659. - default: 1
  660. description: 分页索引
  661. in: query
  662. name: current
  663. required: true
  664. type: integer
  665. - default: 10
  666. description: 分页大小
  667. in: query
  668. name: pageSize
  669. required: true
  670. type: integer
  671. - description: 查询值
  672. in: query
  673. name: queryValue
  674. type: string
  675. - description: 状态(1:启用 2:禁用)
  676. in: query
  677. name: status
  678. type: integer
  679. - description: 显示状态(1:显示 2:隐藏)
  680. in: query
  681. name: showStatus
  682. type: integer
  683. - description: 父级ID
  684. in: query
  685. name: parentID
  686. type: string
  687. responses:
  688. "200":
  689. description: 查询结果
  690. schema:
  691. allOf:
  692. - $ref: '#/definitions/schema.ListResult'
  693. - properties:
  694. list:
  695. items:
  696. $ref: '#/definitions/schema.Menu'
  697. type: array
  698. type: object
  699. "401":
  700. description: '{error:{code:0,message:未授权}}'
  701. schema:
  702. $ref: '#/definitions/schema.ErrorResult'
  703. "500":
  704. description: '{error:{code:0,message:服务器错误}}'
  705. schema:
  706. $ref: '#/definitions/schema.ErrorResult'
  707. security:
  708. - ApiKeyAuth: []
  709. summary: 查询数据
  710. tags:
  711. - 菜单管理
  712. post:
  713. parameters:
  714. - description: 创建数据
  715. in: body
  716. name: body
  717. required: true
  718. schema:
  719. $ref: '#/definitions/schema.Menu'
  720. responses:
  721. "200":
  722. description: OK
  723. schema:
  724. $ref: '#/definitions/schema.IDResult'
  725. "400":
  726. description: '{error:{code:0,message:无效的请求参数}}'
  727. schema:
  728. $ref: '#/definitions/schema.ErrorResult'
  729. "401":
  730. description: '{error:{code:0,message:未授权}}'
  731. schema:
  732. $ref: '#/definitions/schema.ErrorResult'
  733. "500":
  734. description: '{error:{code:0,message:服务器错误}}'
  735. schema:
  736. $ref: '#/definitions/schema.ErrorResult'
  737. security:
  738. - ApiKeyAuth: []
  739. summary: 创建数据
  740. tags:
  741. - 菜单管理
  742. /api/v1/menus.tree:
  743. get:
  744. parameters:
  745. - description: 状态(1:启用 2:禁用)
  746. in: query
  747. name: status
  748. type: integer
  749. - description: 父级ID
  750. in: query
  751. name: parentID
  752. type: string
  753. responses:
  754. "200":
  755. description: 查询结果
  756. schema:
  757. allOf:
  758. - $ref: '#/definitions/schema.ListResult'
  759. - properties:
  760. list:
  761. items:
  762. $ref: '#/definitions/schema.MenuTree'
  763. type: array
  764. type: object
  765. "401":
  766. description: '{error:{code:0,message:未授权}}'
  767. schema:
  768. $ref: '#/definitions/schema.ErrorResult'
  769. "500":
  770. description: '{error:{code:0,message:服务器错误}}'
  771. schema:
  772. $ref: '#/definitions/schema.ErrorResult'
  773. security:
  774. - ApiKeyAuth: []
  775. summary: 查询菜单树
  776. tags:
  777. - 菜单管理
  778. /api/v1/menus/{id}:
  779. delete:
  780. parameters:
  781. - description: 唯一标识
  782. in: path
  783. name: id
  784. required: true
  785. type: string
  786. responses:
  787. "200":
  788. description: '{status:OK}'
  789. schema:
  790. $ref: '#/definitions/schema.StatusResult'
  791. "401":
  792. description: '{error:{code:0,message:未授权}}'
  793. schema:
  794. $ref: '#/definitions/schema.ErrorResult'
  795. "500":
  796. description: '{error:{code:0,message:服务器错误}}'
  797. schema:
  798. $ref: '#/definitions/schema.ErrorResult'
  799. security:
  800. - ApiKeyAuth: []
  801. summary: 删除数据
  802. tags:
  803. - 菜单管理
  804. get:
  805. parameters:
  806. - description: 唯一标识
  807. in: path
  808. name: id
  809. required: true
  810. type: string
  811. responses:
  812. "200":
  813. description: OK
  814. schema:
  815. $ref: '#/definitions/schema.Menu'
  816. "401":
  817. description: '{error:{code:0,message:未授权}}'
  818. schema:
  819. $ref: '#/definitions/schema.ErrorResult'
  820. "404":
  821. description: '{error:{code:0,message:资源不存在}}'
  822. schema:
  823. $ref: '#/definitions/schema.ErrorResult'
  824. "500":
  825. description: '{error:{code:0,message:服务器错误}}'
  826. schema:
  827. $ref: '#/definitions/schema.ErrorResult'
  828. security:
  829. - ApiKeyAuth: []
  830. summary: 查询指定数据
  831. tags:
  832. - 菜单管理
  833. put:
  834. parameters:
  835. - description: 唯一标识
  836. in: path
  837. name: id
  838. required: true
  839. type: string
  840. - description: 更新数据
  841. in: body
  842. name: body
  843. required: true
  844. schema:
  845. $ref: '#/definitions/schema.Menu'
  846. responses:
  847. "200":
  848. description: '{status:OK}'
  849. schema:
  850. $ref: '#/definitions/schema.StatusResult'
  851. "400":
  852. description: '{error:{code:0,message:无效的请求参数}}'
  853. schema:
  854. $ref: '#/definitions/schema.ErrorResult'
  855. "401":
  856. description: '{error:{code:0,message:未授权}}'
  857. schema:
  858. $ref: '#/definitions/schema.ErrorResult'
  859. "500":
  860. description: '{error:{code:0,message:服务器错误}}'
  861. schema:
  862. $ref: '#/definitions/schema.ErrorResult'
  863. security:
  864. - ApiKeyAuth: []
  865. summary: 更新数据
  866. tags:
  867. - 菜单管理
  868. /api/v1/menus/{id}/disable:
  869. patch:
  870. parameters:
  871. - description: 唯一标识
  872. in: path
  873. name: id
  874. required: true
  875. type: string
  876. responses:
  877. "200":
  878. description: '{status:OK}'
  879. schema:
  880. $ref: '#/definitions/schema.StatusResult'
  881. "401":
  882. description: '{error:{code:0,message:未授权}}'
  883. schema:
  884. $ref: '#/definitions/schema.ErrorResult'
  885. "500":
  886. description: '{error:{code:0,message:服务器错误}}'
  887. schema:
  888. $ref: '#/definitions/schema.ErrorResult'
  889. security:
  890. - ApiKeyAuth: []
  891. summary: 禁用数据
  892. tags:
  893. - 菜单管理
  894. /api/v1/menus/{id}/enable:
  895. patch:
  896. parameters:
  897. - description: 唯一标识
  898. in: path
  899. name: id
  900. required: true
  901. type: string
  902. responses:
  903. "200":
  904. description: '{status:OK}'
  905. schema:
  906. $ref: '#/definitions/schema.StatusResult'
  907. "401":
  908. description: '{error:{code:0,message:未授权}}'
  909. schema:
  910. $ref: '#/definitions/schema.ErrorResult'
  911. "500":
  912. description: '{error:{code:0,message:服务器错误}}'
  913. schema:
  914. $ref: '#/definitions/schema.ErrorResult'
  915. security:
  916. - ApiKeyAuth: []
  917. summary: 启用数据
  918. tags:
  919. - 菜单管理
  920. /api/v1/pub/current/menutree:
  921. get:
  922. responses:
  923. "200":
  924. description: 查询结果
  925. schema:
  926. allOf:
  927. - $ref: '#/definitions/schema.ListResult'
  928. - properties:
  929. list:
  930. items:
  931. $ref: '#/definitions/schema.MenuTree'
  932. type: array
  933. type: object
  934. "401":
  935. description: '{error:{code:0,message:未授权}}'
  936. schema:
  937. $ref: '#/definitions/schema.ErrorResult'
  938. "500":
  939. description: '{error:{code:0,message:服务器错误}}'
  940. schema:
  941. $ref: '#/definitions/schema.ErrorResult'
  942. security:
  943. - ApiKeyAuth: []
  944. summary: 查询当前用户菜单树
  945. tags:
  946. - 登录管理
  947. /api/v1/pub/current/password:
  948. put:
  949. parameters:
  950. - description: 请求参数
  951. in: body
  952. name: body
  953. required: true
  954. schema:
  955. $ref: '#/definitions/schema.UpdatePasswordParam'
  956. responses:
  957. "200":
  958. description: '{status:OK}'
  959. schema:
  960. $ref: '#/definitions/schema.StatusResult'
  961. "400":
  962. description: '{error:{code:0,message:无效的请求参数}}'
  963. schema:
  964. $ref: '#/definitions/schema.ErrorResult'
  965. "401":
  966. description: '{error:{code:0,message:未授权}}'
  967. schema:
  968. $ref: '#/definitions/schema.ErrorResult'
  969. "500":
  970. description: '{error:{code:0,message:服务器错误}}'
  971. schema:
  972. $ref: '#/definitions/schema.ErrorResult'
  973. security:
  974. - ApiKeyAuth: []
  975. summary: 更新个人密码
  976. tags:
  977. - 登录管理
  978. /api/v1/pub/current/user:
  979. get:
  980. responses:
  981. "200":
  982. description: OK
  983. schema:
  984. $ref: '#/definitions/schema.UserLoginInfo'
  985. "401":
  986. description: '{error:{code:0,message:未授权}}'
  987. schema:
  988. $ref: '#/definitions/schema.ErrorResult'
  989. "500":
  990. description: '{error:{code:0,message:服务器错误}}'
  991. schema:
  992. $ref: '#/definitions/schema.ErrorResult'
  993. security:
  994. - ApiKeyAuth: []
  995. summary: 获取当前用户信息
  996. tags:
  997. - 登录管理
  998. /api/v1/pub/login:
  999. post:
  1000. parameters:
  1001. - description: 请求参数
  1002. in: body
  1003. name: body
  1004. required: true
  1005. schema:
  1006. $ref: '#/definitions/schema.LoginParam'
  1007. responses:
  1008. "200":
  1009. description: OK
  1010. schema:
  1011. $ref: '#/definitions/schema.LoginTokenInfo'
  1012. "400":
  1013. description: '{error:{code:0,message:无效的请求参数}}'
  1014. schema:
  1015. $ref: '#/definitions/schema.ErrorResult'
  1016. "500":
  1017. description: '{error:{code:0,message:服务器错误}}'
  1018. schema:
  1019. $ref: '#/definitions/schema.ErrorResult'
  1020. summary: 用户登录
  1021. tags:
  1022. - 登录管理
  1023. /api/v1/pub/login/captcha:
  1024. get:
  1025. parameters:
  1026. - description: 验证码ID
  1027. in: query
  1028. name: id
  1029. required: true
  1030. type: string
  1031. - description: 重新加载
  1032. in: query
  1033. name: reload
  1034. type: string
  1035. produces:
  1036. - image/png
  1037. responses:
  1038. "200":
  1039. description: 图形验证码
  1040. "400":
  1041. description: '{error:{code:0,message:无效的请求参数}}'
  1042. schema:
  1043. $ref: '#/definitions/schema.ErrorResult'
  1044. "500":
  1045. description: '{error:{code:0,message:服务器错误}}'
  1046. schema:
  1047. $ref: '#/definitions/schema.ErrorResult'
  1048. summary: 响应图形验证码
  1049. tags:
  1050. - 登录管理
  1051. /api/v1/pub/login/captchaid:
  1052. get:
  1053. responses:
  1054. "200":
  1055. description: OK
  1056. schema:
  1057. $ref: '#/definitions/schema.LoginCaptcha'
  1058. summary: 获取验证码信息
  1059. tags:
  1060. - 登录管理
  1061. /api/v1/pub/login/exit:
  1062. post:
  1063. responses:
  1064. "200":
  1065. description: '{status:OK}'
  1066. schema:
  1067. $ref: '#/definitions/schema.StatusResult'
  1068. summary: 用户登出
  1069. tags:
  1070. - 登录管理
  1071. /api/v1/pub/refresh-token:
  1072. post:
  1073. responses:
  1074. "200":
  1075. description: OK
  1076. schema:
  1077. $ref: '#/definitions/schema.LoginTokenInfo'
  1078. "401":
  1079. description: '{error:{code:0,message:未授权}}'
  1080. schema:
  1081. $ref: '#/definitions/schema.ErrorResult'
  1082. "500":
  1083. description: '{error:{code:0,message:服务器错误}}'
  1084. schema:
  1085. $ref: '#/definitions/schema.ErrorResult'
  1086. security:
  1087. - ApiKeyAuth: []
  1088. summary: 刷新令牌
  1089. tags:
  1090. - 登录管理
  1091. /api/v1/roles:
  1092. get:
  1093. parameters:
  1094. - default: 1
  1095. description: 分页索引
  1096. in: query
  1097. name: current
  1098. required: true
  1099. type: integer
  1100. - default: 10
  1101. description: 分页大小
  1102. in: query
  1103. name: pageSize
  1104. required: true
  1105. type: integer
  1106. - description: 查询值
  1107. in: query
  1108. name: queryValue
  1109. type: string
  1110. - description: 状态(1:启用 2:禁用)
  1111. in: query
  1112. name: status
  1113. type: integer
  1114. responses:
  1115. "200":
  1116. description: 查询结果
  1117. schema:
  1118. allOf:
  1119. - $ref: '#/definitions/schema.ListResult'
  1120. - properties:
  1121. list:
  1122. items:
  1123. $ref: '#/definitions/schema.Role'
  1124. type: array
  1125. type: object
  1126. "401":
  1127. description: '{error:{code:0,message:未授权}}'
  1128. schema:
  1129. $ref: '#/definitions/schema.ErrorResult'
  1130. "500":
  1131. description: '{error:{code:0,message:服务器错误}}'
  1132. schema:
  1133. $ref: '#/definitions/schema.ErrorResult'
  1134. security:
  1135. - ApiKeyAuth: []
  1136. summary: 查询数据
  1137. tags:
  1138. - 角色管理
  1139. post:
  1140. parameters:
  1141. - description: 创建数据
  1142. in: body
  1143. name: body
  1144. required: true
  1145. schema:
  1146. $ref: '#/definitions/schema.Role'
  1147. responses:
  1148. "200":
  1149. description: OK
  1150. schema:
  1151. $ref: '#/definitions/schema.IDResult'
  1152. "400":
  1153. description: '{error:{code:0,message:无效的请求参数}}'
  1154. schema:
  1155. $ref: '#/definitions/schema.ErrorResult'
  1156. "401":
  1157. description: '{error:{code:0,message:未授权}}'
  1158. schema:
  1159. $ref: '#/definitions/schema.ErrorResult'
  1160. "500":
  1161. description: '{error:{code:0,message:服务器错误}}'
  1162. schema:
  1163. $ref: '#/definitions/schema.ErrorResult'
  1164. security:
  1165. - ApiKeyAuth: []
  1166. summary: 创建数据
  1167. tags:
  1168. - 角色管理
  1169. /api/v1/roles.select:
  1170. get:
  1171. parameters:
  1172. - description: 查询值
  1173. in: query
  1174. name: queryValue
  1175. type: string
  1176. - description: 状态(1:启用 2:禁用)
  1177. in: query
  1178. name: status
  1179. type: integer
  1180. responses:
  1181. "200":
  1182. description: 查询结果
  1183. schema:
  1184. allOf:
  1185. - $ref: '#/definitions/schema.ListResult'
  1186. - properties:
  1187. list:
  1188. items:
  1189. $ref: '#/definitions/schema.Role'
  1190. type: array
  1191. type: object
  1192. "400":
  1193. description: '{error:{code:0,message:未知的查询类型}}'
  1194. schema:
  1195. $ref: '#/definitions/schema.ErrorResult'
  1196. "401":
  1197. description: '{error:{code:0,message:未授权}}'
  1198. schema:
  1199. $ref: '#/definitions/schema.ErrorResult'
  1200. "500":
  1201. description: '{error:{code:0,message:服务器错误}}'
  1202. schema:
  1203. $ref: '#/definitions/schema.ErrorResult'
  1204. security:
  1205. - ApiKeyAuth: []
  1206. summary: 查询选择数据
  1207. tags:
  1208. - 角色管理
  1209. /api/v1/roles/{id}:
  1210. delete:
  1211. parameters:
  1212. - description: 唯一标识
  1213. in: path
  1214. name: id
  1215. required: true
  1216. type: string
  1217. responses:
  1218. "200":
  1219. description: '{status:OK}'
  1220. schema:
  1221. $ref: '#/definitions/schema.StatusResult'
  1222. "401":
  1223. description: '{error:{code:0,message:未授权}}'
  1224. schema:
  1225. $ref: '#/definitions/schema.ErrorResult'
  1226. "500":
  1227. description: '{error:{code:0,message:服务器错误}}'
  1228. schema:
  1229. $ref: '#/definitions/schema.ErrorResult'
  1230. security:
  1231. - ApiKeyAuth: []
  1232. summary: 删除数据
  1233. tags:
  1234. - 角色管理
  1235. get:
  1236. parameters:
  1237. - description: 唯一标识
  1238. in: path
  1239. name: id
  1240. required: true
  1241. type: string
  1242. responses:
  1243. "200":
  1244. description: OK
  1245. schema:
  1246. $ref: '#/definitions/schema.Role'
  1247. "401":
  1248. description: '{error:{code:0,message:未授权}}'
  1249. schema:
  1250. $ref: '#/definitions/schema.ErrorResult'
  1251. "404":
  1252. description: '{error:{code:0,message:资源不存在}}'
  1253. schema:
  1254. $ref: '#/definitions/schema.ErrorResult'
  1255. "500":
  1256. description: '{error:{code:0,message:服务器错误}}'
  1257. schema:
  1258. $ref: '#/definitions/schema.ErrorResult'
  1259. security:
  1260. - ApiKeyAuth: []
  1261. summary: 查询指定数据
  1262. tags:
  1263. - 角色管理
  1264. put:
  1265. parameters:
  1266. - description: 唯一标识
  1267. in: path
  1268. name: id
  1269. required: true
  1270. type: string
  1271. - description: 更新数据
  1272. in: body
  1273. name: body
  1274. required: true
  1275. schema:
  1276. $ref: '#/definitions/schema.Role'
  1277. responses:
  1278. "200":
  1279. description: OK
  1280. schema:
  1281. $ref: '#/definitions/schema.Role'
  1282. "400":
  1283. description: '{error:{code:0,message:无效的请求参数}}'
  1284. schema:
  1285. $ref: '#/definitions/schema.ErrorResult'
  1286. "401":
  1287. description: '{error:{code:0,message:未授权}}'
  1288. schema:
  1289. $ref: '#/definitions/schema.ErrorResult'
  1290. "500":
  1291. description: '{error:{code:0,message:服务器错误}}'
  1292. schema:
  1293. $ref: '#/definitions/schema.ErrorResult'
  1294. security:
  1295. - ApiKeyAuth: []
  1296. summary: 更新数据
  1297. tags:
  1298. - 角色管理
  1299. /api/v1/roles/{id}/disable:
  1300. patch:
  1301. parameters:
  1302. - description: 唯一标识
  1303. in: path
  1304. name: id
  1305. required: true
  1306. type: string
  1307. responses:
  1308. "200":
  1309. description: '{status:OK}'
  1310. schema:
  1311. $ref: '#/definitions/schema.StatusResult'
  1312. "401":
  1313. description: '{error:{code:0,message:未授权}}'
  1314. schema:
  1315. $ref: '#/definitions/schema.ErrorResult'
  1316. "500":
  1317. description: '{error:{code:0,message:服务器错误}}'
  1318. schema:
  1319. $ref: '#/definitions/schema.ErrorResult'
  1320. security:
  1321. - ApiKeyAuth: []
  1322. summary: 禁用数据
  1323. tags:
  1324. - 角色管理
  1325. /api/v1/roles/{id}/enable:
  1326. patch:
  1327. parameters:
  1328. - description: 唯一标识
  1329. in: path
  1330. name: id
  1331. required: true
  1332. type: string
  1333. responses:
  1334. "200":
  1335. description: '{status:OK}'
  1336. schema:
  1337. $ref: '#/definitions/schema.StatusResult'
  1338. "401":
  1339. description: '{error:{code:0,message:未授权}}'
  1340. schema:
  1341. $ref: '#/definitions/schema.ErrorResult'
  1342. "500":
  1343. description: '{error:{code:0,message:服务器错误}}'
  1344. schema:
  1345. $ref: '#/definitions/schema.ErrorResult'
  1346. security:
  1347. - ApiKeyAuth: []
  1348. summary: 启用数据
  1349. tags:
  1350. - 角色管理
  1351. /api/v1/users:
  1352. get:
  1353. parameters:
  1354. - default: 1
  1355. description: 分页索引
  1356. in: query
  1357. name: current
  1358. required: true
  1359. type: integer
  1360. - default: 10
  1361. description: 分页大小
  1362. in: query
  1363. name: pageSize
  1364. required: true
  1365. type: integer
  1366. - description: 查询值
  1367. in: query
  1368. name: queryValue
  1369. type: string
  1370. - description: 角色ID(多个以英文逗号分隔)
  1371. in: query
  1372. name: roleIDs
  1373. type: string
  1374. - description: 状态(1:启用 2:停用)
  1375. in: query
  1376. name: status
  1377. type: integer
  1378. responses:
  1379. "200":
  1380. description: 查询结果
  1381. schema:
  1382. allOf:
  1383. - $ref: '#/definitions/schema.ListResult'
  1384. - properties:
  1385. list:
  1386. items:
  1387. $ref: '#/definitions/schema.UserShow'
  1388. type: array
  1389. type: object
  1390. "401":
  1391. description: '{error:{code:0,message:未授权}}'
  1392. schema:
  1393. $ref: '#/definitions/schema.ErrorResult'
  1394. "500":
  1395. description: '{error:{code:0,message:服务器错误}}'
  1396. schema:
  1397. $ref: '#/definitions/schema.ErrorResult'
  1398. security:
  1399. - ApiKeyAuth: []
  1400. summary: 查询数据
  1401. tags:
  1402. - 用户管理
  1403. post:
  1404. parameters:
  1405. - description: 创建数据
  1406. in: body
  1407. name: body
  1408. required: true
  1409. schema:
  1410. $ref: '#/definitions/schema.User'
  1411. responses:
  1412. "200":
  1413. description: OK
  1414. schema:
  1415. $ref: '#/definitions/schema.IDResult'
  1416. "400":
  1417. description: '{error:{code:0,message:无效的请求参数}}'
  1418. schema:
  1419. $ref: '#/definitions/schema.ErrorResult'
  1420. "401":
  1421. description: '{error:{code:0,message:未授权}}'
  1422. schema:
  1423. $ref: '#/definitions/schema.ErrorResult'
  1424. "500":
  1425. description: '{error:{code:0,message:服务器错误}}'
  1426. schema:
  1427. $ref: '#/definitions/schema.ErrorResult'
  1428. security:
  1429. - ApiKeyAuth: []
  1430. summary: 创建数据
  1431. tags:
  1432. - 用户管理
  1433. /api/v1/users/{id}:
  1434. delete:
  1435. parameters:
  1436. - description: 唯一标识
  1437. in: path
  1438. name: id
  1439. required: true
  1440. type: string
  1441. responses:
  1442. "200":
  1443. description: '{status:OK}'
  1444. schema:
  1445. $ref: '#/definitions/schema.StatusResult'
  1446. "401":
  1447. description: '{error:{code:0,message:未授权}}'
  1448. schema:
  1449. $ref: '#/definitions/schema.ErrorResult'
  1450. "500":
  1451. description: '{error:{code:0,message:服务器错误}}'
  1452. schema:
  1453. $ref: '#/definitions/schema.ErrorResult'
  1454. security:
  1455. - ApiKeyAuth: []
  1456. summary: 删除数据
  1457. tags:
  1458. - 用户管理
  1459. get:
  1460. parameters:
  1461. - description: 唯一标识
  1462. in: path
  1463. name: id
  1464. required: true
  1465. type: string
  1466. responses:
  1467. "200":
  1468. description: OK
  1469. schema:
  1470. $ref: '#/definitions/schema.User'
  1471. "401":
  1472. description: '{error:{code:0,message:未授权}}'
  1473. schema:
  1474. $ref: '#/definitions/schema.ErrorResult'
  1475. "404":
  1476. description: '{error:{code:0,message:资源不存在}}'
  1477. schema:
  1478. $ref: '#/definitions/schema.ErrorResult'
  1479. "500":
  1480. description: '{error:{code:0,message:服务器错误}}'
  1481. schema:
  1482. $ref: '#/definitions/schema.ErrorResult'
  1483. security:
  1484. - ApiKeyAuth: []
  1485. summary: 查询指定数据
  1486. tags:
  1487. - 用户管理
  1488. put:
  1489. parameters:
  1490. - description: 唯一标识
  1491. in: path
  1492. name: id
  1493. required: true
  1494. type: string
  1495. - description: 更新数据
  1496. in: body
  1497. name: body
  1498. required: true
  1499. schema:
  1500. $ref: '#/definitions/schema.User'
  1501. responses:
  1502. "200":
  1503. description: OK
  1504. schema:
  1505. $ref: '#/definitions/schema.User'
  1506. "400":
  1507. description: '{error:{code:0,message:无效的请求参数}}'
  1508. schema:
  1509. $ref: '#/definitions/schema.ErrorResult'
  1510. "401":
  1511. description: '{error:{code:0,message:未授权}}'
  1512. schema:
  1513. $ref: '#/definitions/schema.ErrorResult'
  1514. "500":
  1515. description: '{error:{code:0,message:服务器错误}}'
  1516. schema:
  1517. $ref: '#/definitions/schema.ErrorResult'
  1518. security:
  1519. - ApiKeyAuth: []
  1520. summary: 更新数据
  1521. tags:
  1522. - 用户管理
  1523. /api/v1/users/{id}/disable:
  1524. patch:
  1525. parameters:
  1526. - description: 唯一标识
  1527. in: path
  1528. name: id
  1529. required: true
  1530. type: string
  1531. responses:
  1532. "200":
  1533. description: '{status:OK}'
  1534. schema:
  1535. $ref: '#/definitions/schema.StatusResult'
  1536. "401":
  1537. description: '{error:{code:0,message:未授权}}'
  1538. schema:
  1539. $ref: '#/definitions/schema.ErrorResult'
  1540. "500":
  1541. description: '{error:{code:0,message:服务器错误}}'
  1542. schema:
  1543. $ref: '#/definitions/schema.ErrorResult'
  1544. security:
  1545. - ApiKeyAuth: []
  1546. summary: 禁用数据
  1547. tags:
  1548. - 用户管理
  1549. /api/v1/users/{id}/enable:
  1550. patch:
  1551. parameters:
  1552. - description: 唯一标识
  1553. in: path
  1554. name: id
  1555. required: true
  1556. type: string
  1557. responses:
  1558. "200":
  1559. description: '{status:OK}'
  1560. schema:
  1561. $ref: '#/definitions/schema.StatusResult'
  1562. "401":
  1563. description: '{error:{code:0,message:未授权}}'
  1564. schema:
  1565. $ref: '#/definitions/schema.ErrorResult'
  1566. "500":
  1567. description: '{error:{code:0,message:服务器错误}}'
  1568. schema:
  1569. $ref: '#/definitions/schema.ErrorResult'
  1570. security:
  1571. - ApiKeyAuth: []
  1572. summary: 启用数据
  1573. tags:
  1574. - 用户管理
  1575. schemes:
  1576. - http
  1577. - https
  1578. securityDefinitions:
  1579. ApiKeyAuth:
  1580. in: header
  1581. name: Authorization
  1582. type: apiKey
  1583. swagger: "2.0"