swagger.yaml 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445
  1. definitions:
  2. app.Page:
  3. properties:
  4. count:
  5. type: integer
  6. list:
  7. type: object
  8. pageIndex:
  9. type: integer
  10. pageSize:
  11. type: integer
  12. type: object
  13. app.PageResponse:
  14. properties:
  15. code:
  16. description: 代码
  17. example: 200
  18. type: integer
  19. data:
  20. $ref: '#/definitions/app.Page'
  21. description: 数据集
  22. type: object
  23. msg:
  24. description: 消息
  25. type: string
  26. type: object
  27. app.Response:
  28. properties:
  29. code:
  30. description: 代码
  31. example: 200
  32. type: integer
  33. data:
  34. description: 数据集
  35. type: object
  36. msg:
  37. description: 消息
  38. type: string
  39. type: object
  40. models.DictType:
  41. properties:
  42. createBy:
  43. description: 创建者
  44. type: string
  45. createdAt:
  46. type: string
  47. dataScope:
  48. type: string
  49. deletedAt:
  50. type: string
  51. dictId:
  52. type: integer
  53. dictName:
  54. description: 字典名称
  55. type: string
  56. dictType:
  57. description: 字典类型
  58. type: string
  59. params:
  60. type: string
  61. remark:
  62. description: 备注
  63. type: string
  64. status:
  65. description: 状态
  66. type: string
  67. updateBy:
  68. description: 更新者
  69. type: string
  70. updatedAt:
  71. type: string
  72. type: object
  73. models.Login:
  74. properties:
  75. code:
  76. type: string
  77. password:
  78. type: string
  79. username:
  80. type: string
  81. uuid:
  82. type: string
  83. required:
  84. - code
  85. - password
  86. - username
  87. - uuid
  88. type: object
  89. models.LoginLog:
  90. properties:
  91. browser:
  92. description: 浏览器
  93. type: string
  94. createBy:
  95. description: 创建人
  96. type: string
  97. createdAt:
  98. type: string
  99. dataScope:
  100. description: 数据
  101. type: string
  102. deletedAt:
  103. type: string
  104. infoId:
  105. description: 主键
  106. type: integer
  107. ipaddr:
  108. description: ip地址
  109. type: string
  110. loginLocation:
  111. description: 归属地
  112. type: string
  113. loginTime:
  114. description: 登录时间
  115. type: string
  116. msg:
  117. type: string
  118. os:
  119. description: 系统
  120. type: string
  121. params:
  122. type: string
  123. platform:
  124. description: 固件
  125. type: string
  126. remark:
  127. description: 备注
  128. type: string
  129. status:
  130. description: 状态
  131. type: string
  132. updateBy:
  133. description: 更新者
  134. type: string
  135. updatedAt:
  136. type: string
  137. username:
  138. description: 用户名
  139. type: string
  140. type: object
  141. models.Menu:
  142. properties:
  143. action:
  144. type: string
  145. breadcrumb:
  146. type: string
  147. children:
  148. items:
  149. $ref: '#/definitions/models.Menu'
  150. type: array
  151. component:
  152. type: string
  153. createBy:
  154. type: string
  155. createdAt:
  156. type: string
  157. dataScope:
  158. type: string
  159. deletedAt:
  160. type: string
  161. icon:
  162. type: string
  163. is_select:
  164. type: boolean
  165. isFrame:
  166. type: string
  167. menuId:
  168. type: integer
  169. menuName:
  170. type: string
  171. menuType:
  172. type: string
  173. noCache:
  174. type: boolean
  175. params:
  176. type: string
  177. parentId:
  178. type: integer
  179. path:
  180. type: string
  181. paths:
  182. type: string
  183. permission:
  184. type: string
  185. roleId:
  186. type: integer
  187. sort:
  188. type: integer
  189. title:
  190. type: string
  191. updateBy:
  192. type: string
  193. updatedAt:
  194. type: string
  195. visible:
  196. type: string
  197. type: object
  198. models.Post:
  199. properties:
  200. createBy:
  201. type: string
  202. createdAt:
  203. type: string
  204. dataScope:
  205. type: string
  206. deletedAt:
  207. type: string
  208. params:
  209. type: string
  210. postCode:
  211. description: 岗位代码
  212. type: string
  213. postId:
  214. description: 岗位编号
  215. type: integer
  216. postName:
  217. description: 岗位名称
  218. type: string
  219. remark:
  220. description: 描述
  221. type: string
  222. sort:
  223. description: 岗位排序
  224. type: integer
  225. status:
  226. description: 状态
  227. type: string
  228. updateBy:
  229. type: string
  230. updatedAt:
  231. type: string
  232. type: object
  233. models.SysCategory:
  234. properties:
  235. createBy:
  236. description: 创建者
  237. type: string
  238. createdAt:
  239. type: string
  240. dataScope:
  241. type: string
  242. deletedAt:
  243. type: string
  244. id:
  245. description: 分类Id
  246. type: integer
  247. img:
  248. description: 图片
  249. type: string
  250. name:
  251. description: 名称
  252. type: string
  253. params:
  254. type: string
  255. remark:
  256. description: 备注
  257. type: string
  258. sort:
  259. description: 排序
  260. type: string
  261. status:
  262. description: 状态
  263. type: string
  264. updateBy:
  265. description: 更新者
  266. type: string
  267. updatedAt:
  268. type: string
  269. type: object
  270. models.SysConfig:
  271. properties:
  272. configId:
  273. description: 编码
  274. type: integer
  275. configKey:
  276. description: 参数键名
  277. type: string
  278. configName:
  279. description: 参数名称
  280. type: string
  281. configType:
  282. description: 是否系统内置
  283. type: string
  284. configValue:
  285. description: 参数键值
  286. type: string
  287. createBy:
  288. type: string
  289. createdAt:
  290. type: string
  291. dataScope:
  292. type: string
  293. deletedAt:
  294. type: string
  295. params:
  296. type: string
  297. remark:
  298. description: 备注
  299. type: string
  300. updateBy:
  301. type: string
  302. updatedAt:
  303. type: string
  304. type: object
  305. models.SysContent:
  306. properties:
  307. cateId:
  308. description: 分类id
  309. type: string
  310. content:
  311. description: 内容
  312. type: string
  313. createBy:
  314. description: 创建者
  315. type: string
  316. createdAt:
  317. type: string
  318. dataScope:
  319. type: string
  320. deletedAt:
  321. type: string
  322. id:
  323. description: id
  324. type: integer
  325. img:
  326. description: 图片
  327. type: string
  328. name:
  329. description: 名称
  330. type: string
  331. params:
  332. type: string
  333. remark:
  334. description: 备注
  335. type: string
  336. sort:
  337. description: 排序
  338. type: string
  339. status:
  340. description: 状态
  341. type: string
  342. updateBy:
  343. description: 更新者
  344. type: string
  345. updatedAt:
  346. type: string
  347. type: object
  348. models.SysDept:
  349. properties:
  350. children:
  351. items:
  352. $ref: '#/definitions/models.SysDept'
  353. type: array
  354. createBy:
  355. type: string
  356. createdAt:
  357. type: string
  358. dataScope:
  359. type: string
  360. deletedAt:
  361. type: string
  362. deptId:
  363. description: 部门编码
  364. type: integer
  365. deptName:
  366. description: 部门名称
  367. type: string
  368. deptPath:
  369. type: string
  370. email:
  371. description: 邮箱
  372. type: string
  373. leader:
  374. description: 负责人
  375. type: string
  376. params:
  377. type: string
  378. parentId:
  379. description: 上级部门
  380. type: integer
  381. phone:
  382. description: 手机
  383. type: string
  384. sort:
  385. description: 排序
  386. type: integer
  387. status:
  388. description: 状态
  389. type: string
  390. updateBy:
  391. type: string
  392. updatedAt:
  393. type: string
  394. type: object
  395. models.SysFileDir:
  396. properties:
  397. children:
  398. items:
  399. $ref: '#/definitions/models.SysFileDir'
  400. type: array
  401. createBy:
  402. description: 创建人
  403. type: string
  404. createdAt:
  405. type: string
  406. dataScope:
  407. type: string
  408. deletedAt:
  409. type: string
  410. id:
  411. type: integer
  412. label:
  413. description: 名称
  414. type: string
  415. pId:
  416. description: 父id
  417. type: integer
  418. params:
  419. type: string
  420. path:
  421. type: string
  422. sort:
  423. description: 排序
  424. type: integer
  425. updateBy:
  426. description: 编辑人
  427. type: string
  428. updatedAt:
  429. type: string
  430. type: object
  431. models.SysOperLog:
  432. properties:
  433. businessType:
  434. description: 操作类型
  435. type: string
  436. businessTypes:
  437. type: string
  438. createBy:
  439. description: 创建人
  440. type: string
  441. createdAt:
  442. type: string
  443. dataScope:
  444. description: 数据
  445. type: string
  446. deletedAt:
  447. type: string
  448. deptName:
  449. description: 部门名称
  450. type: string
  451. jsonResult:
  452. description: 返回数据
  453. type: string
  454. latencyime:
  455. description: 耗时
  456. type: string
  457. method:
  458. description: 函数
  459. type: string
  460. operId:
  461. description: 日志编码
  462. type: integer
  463. operIp:
  464. description: 客户端ip
  465. type: string
  466. operLocation:
  467. description: 访问位置
  468. type: string
  469. operName:
  470. description: 操作者
  471. type: string
  472. operParam:
  473. description: 请求参数
  474. type: string
  475. operTime:
  476. description: 操作时间
  477. type: string
  478. operUrl:
  479. description: 访问地址
  480. type: string
  481. operatorType:
  482. description: 操作类型
  483. type: string
  484. params:
  485. description: 参数
  486. type: string
  487. remark:
  488. description: 备注
  489. type: string
  490. requestMethod:
  491. description: 请求方式
  492. type: string
  493. status:
  494. description: 操作状态
  495. type: string
  496. title:
  497. description: 操作模块
  498. type: string
  499. updateBy:
  500. description: 更新者
  501. type: string
  502. updatedAt:
  503. type: string
  504. userAgent:
  505. description: ua
  506. type: string
  507. type: object
  508. models.SysRole:
  509. properties:
  510. admin:
  511. type: boolean
  512. createBy:
  513. type: string
  514. createdAt:
  515. type: string
  516. dataScope:
  517. type: string
  518. deletedAt:
  519. type: string
  520. deptIds:
  521. items:
  522. type: integer
  523. type: array
  524. flag:
  525. type: string
  526. menuIds:
  527. items:
  528. type: integer
  529. type: array
  530. params:
  531. type: string
  532. remark:
  533. description: 备注
  534. type: string
  535. roleId:
  536. description: 角色编码
  537. type: integer
  538. roleKey:
  539. description: 角色代码
  540. type: string
  541. roleName:
  542. description: 角色名称
  543. type: string
  544. roleSort:
  545. description: 角色排序
  546. type: integer
  547. status:
  548. type: string
  549. updateBy:
  550. type: string
  551. updatedAt:
  552. type: string
  553. type: object
  554. models.SysUser:
  555. properties:
  556. avatar:
  557. description: 头像
  558. type: string
  559. createBy:
  560. type: string
  561. createdAt:
  562. type: string
  563. dataScope:
  564. type: string
  565. deletedAt:
  566. type: string
  567. deptId:
  568. description: 部门编码
  569. type: integer
  570. email:
  571. description: 邮箱
  572. type: string
  573. nickName:
  574. description: 昵称
  575. type: string
  576. params:
  577. type: string
  578. password:
  579. description: 密码
  580. type: string
  581. phone:
  582. description: 手机号
  583. type: string
  584. postId:
  585. description: 职位编码
  586. type: integer
  587. remark:
  588. description: 备注
  589. type: string
  590. roleId:
  591. description: 角色编码
  592. type: integer
  593. salt:
  594. description: 盐
  595. type: string
  596. sex:
  597. description: 性别
  598. type: string
  599. status:
  600. type: string
  601. updateBy:
  602. type: string
  603. updatedAt:
  604. type: string
  605. userId:
  606. description: 编码
  607. type: integer
  608. username:
  609. type: string
  610. type: object
  611. tools.Params:
  612. properties:
  613. treeCode:
  614. type: string
  615. treeName:
  616. type: string
  617. treeParentCode:
  618. type: string
  619. type: object
  620. tools.SysColumns:
  621. properties:
  622. columnComment:
  623. type: string
  624. columnId:
  625. type: integer
  626. columnName:
  627. type: string
  628. columnType:
  629. type: string
  630. createBy:
  631. type: string
  632. createdAt:
  633. type: string
  634. deletedAt:
  635. type: string
  636. dictType:
  637. type: string
  638. edit:
  639. type: boolean
  640. fkCol:
  641. items:
  642. $ref: '#/definitions/tools.SysColumns'
  643. type: array
  644. fkLabelId:
  645. type: string
  646. fkLabelName:
  647. type: string
  648. fkTableName:
  649. type: string
  650. fkTableNameClass:
  651. type: string
  652. fkTableNamePackage:
  653. type: string
  654. goField:
  655. type: string
  656. goType:
  657. type: string
  658. htmlType:
  659. type: string
  660. increment:
  661. type: boolean
  662. insert:
  663. type: boolean
  664. isEdit:
  665. type: string
  666. isIncrement:
  667. type: string
  668. isInsert:
  669. type: string
  670. isList:
  671. type: string
  672. isPk:
  673. type: string
  674. isQuery:
  675. type: string
  676. isRequired:
  677. type: string
  678. jsonField:
  679. type: string
  680. list:
  681. type: string
  682. pk:
  683. type: boolean
  684. query:
  685. type: boolean
  686. queryType:
  687. type: string
  688. remark:
  689. type: string
  690. required:
  691. type: boolean
  692. sort:
  693. type: integer
  694. superColumn:
  695. type: boolean
  696. tableId:
  697. type: integer
  698. updateBy:
  699. type: string
  700. updatedAt:
  701. type: string
  702. usableColumn:
  703. type: boolean
  704. type: object
  705. tools.SysTables:
  706. properties:
  707. businessName:
  708. type: string
  709. className:
  710. description: 类名
  711. type: string
  712. columns:
  713. items:
  714. $ref: '#/definitions/tools.SysColumns'
  715. type: array
  716. createBy:
  717. type: string
  718. createdAt:
  719. type: string
  720. crud:
  721. type: boolean
  722. dataScope:
  723. type: string
  724. deletedAt:
  725. type: string
  726. functionAuthor:
  727. description: 功能作者
  728. type: string
  729. functionName:
  730. description: 功能名称
  731. type: string
  732. isLogicalDelete:
  733. type: string
  734. logicalDelete:
  735. type: boolean
  736. logicalDeleteColumn:
  737. type: string
  738. moduleName:
  739. description: 模块名
  740. type: string
  741. options:
  742. type: string
  743. packageName:
  744. description: 包名
  745. type: string
  746. params:
  747. $ref: '#/definitions/tools.Params'
  748. type: object
  749. pkColumn:
  750. type: string
  751. pkGoField:
  752. type: string
  753. pkJsonField:
  754. type: string
  755. remark:
  756. type: string
  757. tableComment:
  758. description: 表备注
  759. type: string
  760. tableId:
  761. description: 表编码
  762. type: integer
  763. tableName:
  764. description: 表名称
  765. type: string
  766. tplCategory:
  767. type: string
  768. tree:
  769. type: boolean
  770. treeCode:
  771. type: string
  772. treeName:
  773. type: string
  774. treeParentCode:
  775. type: string
  776. updateBy:
  777. type: string
  778. updatedAt:
  779. type: string
  780. type: object
  781. info:
  782. contact: {}
  783. description: |-
  784. 基于Gin + Vue + Element UI的前后端分离权限管理系统的接口文档
  785. 添加qq群: 74520518 进入技术交流群 请备注,谢谢!
  786. license:
  787. name: MIT
  788. url: https://github.com/wenjianzhang/device-manage/blob/master/LICENSE.md
  789. title: device-manage API
  790. version: 1.0.1
  791. paths:
  792. /api/v1/config:
  793. put:
  794. consumes:
  795. - application/json
  796. description: 获取JSON
  797. parameters:
  798. - description: body
  799. in: body
  800. name: data
  801. required: true
  802. schema:
  803. $ref: '#/definitions/models.SysConfig'
  804. type: object
  805. responses:
  806. "200":
  807. description: '{"code": -1, "message": "添加失败"}'
  808. schema:
  809. type: string
  810. security:
  811. - Bearer: []
  812. summary: 修改配置
  813. tags:
  814. - 配置
  815. /api/v1/config/{configId}:
  816. delete:
  817. description: 删除数据
  818. parameters:
  819. - description: configId
  820. in: path
  821. name: configId
  822. required: true
  823. type: integer
  824. responses:
  825. "200":
  826. description: '{"code": -1, "message": "删除失败"}'
  827. schema:
  828. type: string
  829. summary: 删除配置
  830. tags:
  831. - 配置
  832. get:
  833. description: 获取JSON
  834. parameters:
  835. - description: 配置编码
  836. in: path
  837. name: configId
  838. required: true
  839. type: integer
  840. responses:
  841. "200":
  842. description: '{"code": 200, "data": [...]}'
  843. schema:
  844. $ref: '#/definitions/app.Response'
  845. security:
  846. - Bearer: []
  847. summary: 获取配置
  848. tags:
  849. - 配置
  850. /api/v1/configKey/{configKey}:
  851. get:
  852. description: 获取JSON
  853. parameters:
  854. - description: configKey
  855. in: path
  856. name: configKey
  857. required: true
  858. type: integer
  859. responses:
  860. "200":
  861. description: '{"code": 200, "data": [...]}'
  862. schema:
  863. $ref: '#/definitions/app.Response'
  864. security:
  865. - Bearer: []
  866. summary: 获取配置
  867. tags:
  868. - 配置
  869. /api/v1/configList:
  870. get:
  871. description: 获取JSON
  872. parameters:
  873. - description: configKey
  874. in: query
  875. name: configKey
  876. type: string
  877. - description: configName
  878. in: query
  879. name: configName
  880. type: string
  881. - description: configType
  882. in: query
  883. name: configType
  884. type: string
  885. - description: 页条数
  886. in: query
  887. name: pageSize
  888. type: integer
  889. - description: 页码
  890. in: query
  891. name: pageIndex
  892. type: integer
  893. responses:
  894. "200":
  895. description: '{"code": 200, "data": [...]}'
  896. schema:
  897. $ref: '#/definitions/app.Response'
  898. security:
  899. - Bearer: []
  900. summary: 配置列表数据
  901. tags:
  902. - 配置
  903. /api/v1/db/columns/page:
  904. get:
  905. description: 数据库表列分页列表 / database table column page list
  906. parameters:
  907. - description: tableName / 数据表名称
  908. in: query
  909. name: tableName
  910. type: string
  911. - description: pageSize / 页条数
  912. in: query
  913. name: pageSize
  914. type: integer
  915. - description: pageIndex / 页码
  916. in: query
  917. name: pageIndex
  918. type: integer
  919. responses:
  920. "200":
  921. description: '{"code": 200, "data": [...]}'
  922. schema:
  923. $ref: '#/definitions/app.Response'
  924. summary: 分页列表数据 / page list data
  925. tags:
  926. - 工具 / Tools
  927. /api/v1/db/tables/page:
  928. get:
  929. description: 数据库表分页列表 / database table page list
  930. parameters:
  931. - description: tableName / 数据表名称
  932. in: query
  933. name: tableName
  934. type: string
  935. - description: pageSize / 页条数
  936. in: query
  937. name: pageSize
  938. type: integer
  939. - description: pageIndex / 页码
  940. in: query
  941. name: pageIndex
  942. type: integer
  943. responses:
  944. "200":
  945. description: '{"code": 200, "data": [...]}'
  946. schema:
  947. $ref: '#/definitions/app.Response'
  948. summary: 分页列表数据 / page list data
  949. tags:
  950. - 工具 / Tools
  951. /api/v1/dept:
  952. post:
  953. consumes:
  954. - application/json
  955. description: 获取JSON
  956. parameters:
  957. - description: data
  958. in: body
  959. name: data
  960. required: true
  961. schema:
  962. $ref: '#/definitions/models.SysDept'
  963. type: object
  964. responses:
  965. "200":
  966. description: '{"code": -1, "message": "添加失败"}'
  967. schema:
  968. type: string
  969. security:
  970. - Bearer: []
  971. summary: 添加部门
  972. tags:
  973. - 部门
  974. put:
  975. consumes:
  976. - application/json
  977. description: 获取JSON
  978. parameters:
  979. - description: id
  980. in: path
  981. name: id
  982. required: true
  983. type: integer
  984. - description: body
  985. in: body
  986. name: data
  987. required: true
  988. schema:
  989. $ref: '#/definitions/models.SysDept'
  990. type: object
  991. responses:
  992. "200":
  993. description: '{"code": -1, "message": "添加失败"}'
  994. schema:
  995. type: string
  996. security:
  997. - Bearer: []
  998. summary: 修改部门
  999. tags:
  1000. - 部门
  1001. /api/v1/dept/{deptId}:
  1002. get:
  1003. description: 获取JSON
  1004. parameters:
  1005. - description: deptId
  1006. in: path
  1007. name: deptId
  1008. type: string
  1009. - description: position
  1010. in: query
  1011. name: position
  1012. type: string
  1013. responses:
  1014. "200":
  1015. description: '{"code": 200, "data": [...]}'
  1016. schema:
  1017. $ref: '#/definitions/app.Response'
  1018. security:
  1019. - Bearer: []
  1020. summary: 部门列表数据
  1021. tags:
  1022. - 部门
  1023. /api/v1/dept/{id}:
  1024. delete:
  1025. description: 删除数据
  1026. parameters:
  1027. - description: id
  1028. in: path
  1029. name: id
  1030. required: true
  1031. type: integer
  1032. responses:
  1033. "200":
  1034. description: '{"code": -1, "message": "删除失败"}'
  1035. schema:
  1036. type: string
  1037. summary: 删除部门
  1038. tags:
  1039. - 部门
  1040. /api/v1/deptList:
  1041. get:
  1042. description: 分页列表
  1043. parameters:
  1044. - description: name
  1045. in: query
  1046. name: name
  1047. type: string
  1048. - description: id
  1049. in: query
  1050. name: id
  1051. type: string
  1052. - description: position
  1053. in: query
  1054. name: position
  1055. type: string
  1056. responses:
  1057. "200":
  1058. description: '{"code": 200, "data": [...]}'
  1059. schema:
  1060. $ref: '#/definitions/app.Response'
  1061. security:
  1062. - Bearer: []
  1063. summary: 分页部门列表数据
  1064. tags:
  1065. - 部门
  1066. /api/v1/dict/data:
  1067. post:
  1068. consumes:
  1069. - application/json
  1070. description: 获取JSON
  1071. parameters:
  1072. - description: data
  1073. in: body
  1074. name: data
  1075. required: true
  1076. schema:
  1077. $ref: '#/definitions/models.DictType'
  1078. type: object
  1079. responses:
  1080. "200":
  1081. description: '{"code": -1, "message": "添加失败"}'
  1082. schema:
  1083. type: string
  1084. security:
  1085. - Bearer: []
  1086. summary: 添加字典数据
  1087. tags:
  1088. - 字典数据
  1089. put:
  1090. consumes:
  1091. - application/json
  1092. description: 获取JSON
  1093. parameters:
  1094. - description: body
  1095. in: body
  1096. name: data
  1097. required: true
  1098. schema:
  1099. $ref: '#/definitions/models.DictType'
  1100. type: object
  1101. responses:
  1102. "200":
  1103. description: '{"code": -1, "message": "添加失败"}'
  1104. schema:
  1105. type: string
  1106. security:
  1107. - Bearer: []
  1108. summary: 修改字典数据
  1109. tags:
  1110. - 字典数据
  1111. /api/v1/dict/data/{dictCode}:
  1112. delete:
  1113. description: 删除数据
  1114. parameters:
  1115. - description: dictCode
  1116. in: path
  1117. name: dictCode
  1118. required: true
  1119. type: integer
  1120. responses:
  1121. "200":
  1122. description: '{"code": -1, "message": "删除失败"}'
  1123. schema:
  1124. type: string
  1125. summary: 删除字典数据
  1126. tags:
  1127. - 字典数据
  1128. get:
  1129. description: 获取JSON
  1130. parameters:
  1131. - description: 字典编码
  1132. in: path
  1133. name: dictCode
  1134. required: true
  1135. type: integer
  1136. responses:
  1137. "200":
  1138. description: '{"code": 200, "data": [...]}'
  1139. schema:
  1140. $ref: '#/definitions/app.Response'
  1141. security:
  1142. - Bearer: []
  1143. summary: 通过编码获取字典数据
  1144. tags:
  1145. - 字典数据
  1146. /api/v1/dict/data/list:
  1147. get:
  1148. description: 获取JSON
  1149. parameters:
  1150. - description: status
  1151. in: query
  1152. name: status
  1153. type: string
  1154. - description: dictCode
  1155. in: query
  1156. name: dictCode
  1157. type: string
  1158. - description: dictType
  1159. in: query
  1160. name: dictType
  1161. type: string
  1162. - description: 页条数
  1163. in: query
  1164. name: pageSize
  1165. type: integer
  1166. - description: 页码
  1167. in: query
  1168. name: pageIndex
  1169. type: integer
  1170. responses:
  1171. "200":
  1172. description: '{"code": 200, "data": [...]}'
  1173. schema:
  1174. $ref: '#/definitions/app.Response'
  1175. security:
  1176. - Bearer: []
  1177. summary: 字典数据列表
  1178. tags:
  1179. - 字典数据
  1180. /api/v1/dict/databyType/{dictType}:
  1181. get:
  1182. description: 获取JSON
  1183. parameters:
  1184. - description: dictType
  1185. in: path
  1186. name: dictType
  1187. required: true
  1188. type: integer
  1189. responses:
  1190. "200":
  1191. description: '{"code": 200, "data": [...]}'
  1192. schema:
  1193. $ref: '#/definitions/app.Response'
  1194. security:
  1195. - Bearer: []
  1196. summary: 通过字典类型获取字典数据
  1197. tags:
  1198. - 字典数据
  1199. /api/v1/dict/type:
  1200. post:
  1201. consumes:
  1202. - application/json
  1203. description: 获取JSON
  1204. parameters:
  1205. - description: data
  1206. in: body
  1207. name: data
  1208. required: true
  1209. schema:
  1210. $ref: '#/definitions/models.DictType'
  1211. type: object
  1212. responses:
  1213. "200":
  1214. description: '{"code": -1, "message": "添加失败"}'
  1215. schema:
  1216. type: string
  1217. security:
  1218. - Bearer: []
  1219. summary: 添加字典类型
  1220. tags:
  1221. - 字典类型
  1222. put:
  1223. consumes:
  1224. - application/json
  1225. description: 获取JSON
  1226. parameters:
  1227. - description: body
  1228. in: body
  1229. name: data
  1230. required: true
  1231. schema:
  1232. $ref: '#/definitions/models.DictType'
  1233. type: object
  1234. responses:
  1235. "200":
  1236. description: '{"code": -1, "message": "添加失败"}'
  1237. schema:
  1238. type: string
  1239. security:
  1240. - Bearer: []
  1241. summary: 修改字典类型
  1242. tags:
  1243. - 字典类型
  1244. /api/v1/dict/type/{dictId}:
  1245. delete:
  1246. description: 删除数据
  1247. parameters:
  1248. - description: dictId
  1249. in: path
  1250. name: dictId
  1251. required: true
  1252. type: integer
  1253. responses:
  1254. "200":
  1255. description: '{"code": -1, "message": "删除失败"}'
  1256. schema:
  1257. type: string
  1258. summary: 删除字典类型
  1259. tags:
  1260. - 字典类型
  1261. get:
  1262. description: 获取JSON
  1263. parameters:
  1264. - description: 字典类型编码
  1265. in: path
  1266. name: dictId
  1267. required: true
  1268. type: integer
  1269. responses:
  1270. "200":
  1271. description: '{"code": 200, "data": [...]}'
  1272. schema:
  1273. $ref: '#/definitions/app.Response'
  1274. security:
  1275. - Bearer: []
  1276. summary: 通过字典id获取字典类型
  1277. tags:
  1278. - 字典类型
  1279. /api/v1/dict/type/list:
  1280. get:
  1281. description: 获取JSON
  1282. parameters:
  1283. - description: dictName
  1284. in: query
  1285. name: dictName
  1286. type: string
  1287. - description: dictId
  1288. in: query
  1289. name: dictId
  1290. type: string
  1291. - description: dictType
  1292. in: query
  1293. name: dictType
  1294. type: string
  1295. - description: 页条数
  1296. in: query
  1297. name: pageSize
  1298. type: integer
  1299. - description: 页码
  1300. in: query
  1301. name: pageIndex
  1302. type: integer
  1303. responses:
  1304. "200":
  1305. description: '{"code": 200, "data": [...]}'
  1306. schema:
  1307. $ref: '#/definitions/app.PageResponse'
  1308. security:
  1309. - Bearer: []
  1310. summary: 字典类型列表数据
  1311. tags:
  1312. - 字典类型
  1313. /api/v1/loginlog:
  1314. post:
  1315. consumes:
  1316. - application/json
  1317. description: 获取JSON
  1318. parameters:
  1319. - description: data
  1320. in: body
  1321. name: data
  1322. required: true
  1323. schema:
  1324. $ref: '#/definitions/models.LoginLog'
  1325. type: object
  1326. responses:
  1327. "200":
  1328. description: '{"code": -1, "message": "添加失败"}'
  1329. schema:
  1330. type: string
  1331. security:
  1332. - Bearer: []
  1333. summary: 添加登录日志
  1334. tags:
  1335. - 登录日志
  1336. put:
  1337. consumes:
  1338. - application/json
  1339. description: 获取JSON
  1340. parameters:
  1341. - description: body
  1342. in: body
  1343. name: data
  1344. required: true
  1345. schema:
  1346. $ref: '#/definitions/models.LoginLog'
  1347. type: object
  1348. responses:
  1349. "200":
  1350. description: '{"code": -1, "message": "添加失败"}'
  1351. schema:
  1352. type: string
  1353. security:
  1354. - Bearer: []
  1355. summary: 修改登录日志
  1356. tags:
  1357. - 登录日志
  1358. /api/v1/loginlog/{infoId}:
  1359. delete:
  1360. description: 删除数据
  1361. parameters:
  1362. - description: 以逗号(,)分割的infoId
  1363. in: path
  1364. name: infoId
  1365. required: true
  1366. type: string
  1367. responses:
  1368. "200":
  1369. description: '{"code": -1, "message": "删除失败"}'
  1370. schema:
  1371. type: string
  1372. summary: 批量删除登录日志
  1373. tags:
  1374. - 登录日志
  1375. get:
  1376. description: 获取JSON
  1377. parameters:
  1378. - description: infoId
  1379. in: path
  1380. name: infoId
  1381. required: true
  1382. type: integer
  1383. responses:
  1384. "200":
  1385. description: '{"code": 200, "data": [...]}'
  1386. schema:
  1387. $ref: '#/definitions/app.Response'
  1388. security:
  1389. - Bearer: []
  1390. summary: 通过编码获取登录日志
  1391. tags:
  1392. - 登录日志
  1393. /api/v1/loginloglist:
  1394. get:
  1395. description: 获取JSON
  1396. parameters:
  1397. - description: status
  1398. in: query
  1399. name: status
  1400. type: string
  1401. - description: dictCode
  1402. in: query
  1403. name: dictCode
  1404. type: string
  1405. - description: dictType
  1406. in: query
  1407. name: dictType
  1408. type: string
  1409. - description: 页条数
  1410. in: query
  1411. name: pageSize
  1412. type: integer
  1413. - description: 页码
  1414. in: query
  1415. name: pageIndex
  1416. type: integer
  1417. responses:
  1418. "200":
  1419. description: '{"code": 200, "data": [...]}'
  1420. schema:
  1421. $ref: '#/definitions/app.Response'
  1422. security:
  1423. - Bearer: []
  1424. summary: 登录日志列表
  1425. tags:
  1426. - 登录日志
  1427. /api/v1/menu:
  1428. get:
  1429. description: 获取JSON
  1430. parameters:
  1431. - description: menuName
  1432. in: query
  1433. name: menuName
  1434. type: string
  1435. responses:
  1436. "200":
  1437. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  1438. schema:
  1439. type: string
  1440. security:
  1441. - Bearer: []
  1442. summary: Menu列表数据
  1443. tags:
  1444. - 菜单
  1445. post:
  1446. consumes:
  1447. - application/x-www-form-urlencoded
  1448. description: 获取JSON
  1449. parameters:
  1450. - description: menuName
  1451. in: formData
  1452. name: menuName
  1453. required: true
  1454. type: string
  1455. - description: Path
  1456. in: formData
  1457. name: Path
  1458. type: string
  1459. - description: Action
  1460. in: formData
  1461. name: Action
  1462. required: true
  1463. type: string
  1464. - description: Permission
  1465. in: formData
  1466. name: Permission
  1467. required: true
  1468. type: string
  1469. - description: ParentId
  1470. in: formData
  1471. name: ParentId
  1472. required: true
  1473. type: string
  1474. - description: IsDel
  1475. in: formData
  1476. name: IsDel
  1477. required: true
  1478. type: string
  1479. responses:
  1480. "200":
  1481. description: '{"code": -1, "message": "添加失败"}'
  1482. schema:
  1483. type: string
  1484. security:
  1485. - Bearer: []
  1486. summary: 创建菜单
  1487. tags:
  1488. - 菜单
  1489. /api/v1/menu/{id}:
  1490. delete:
  1491. description: 删除数据
  1492. parameters:
  1493. - description: id
  1494. in: path
  1495. name: id
  1496. required: true
  1497. type: integer
  1498. responses:
  1499. "200":
  1500. description: '{"code": -1, "message": "删除失败"}'
  1501. schema:
  1502. type: string
  1503. summary: 删除菜单
  1504. tags:
  1505. - 菜单
  1506. put:
  1507. consumes:
  1508. - application/x-www-form-urlencoded
  1509. description: 获取JSON
  1510. parameters:
  1511. - description: id
  1512. in: path
  1513. name: id
  1514. required: true
  1515. type: integer
  1516. - description: body
  1517. in: body
  1518. name: data
  1519. required: true
  1520. schema:
  1521. $ref: '#/definitions/models.Menu'
  1522. type: object
  1523. responses:
  1524. "200":
  1525. description: '{"code": -1, "message": "修改失败"}'
  1526. schema:
  1527. type: string
  1528. security:
  1529. - Bearer: []
  1530. summary: 修改菜单
  1531. tags:
  1532. - 菜单
  1533. /api/v1/menuTreeselect:
  1534. get:
  1535. consumes:
  1536. - application/x-www-form-urlencoded
  1537. description: 获取JSON
  1538. responses:
  1539. "200":
  1540. description: '{"code": -1, "message": "添加失败"}'
  1541. schema:
  1542. type: string
  1543. security:
  1544. - Bearer: []
  1545. summary: 获取菜单树
  1546. tags:
  1547. - 菜单
  1548. /api/v1/menuids/{id}:
  1549. get:
  1550. description: 获取JSON
  1551. parameters:
  1552. - description: id
  1553. in: path
  1554. name: id
  1555. required: true
  1556. type: integer
  1557. responses:
  1558. "200":
  1559. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  1560. schema:
  1561. type: string
  1562. security:
  1563. - Bearer: []
  1564. summary: 获取角色对应的菜单id数组
  1565. tags:
  1566. - 菜单
  1567. /api/v1/menulist:
  1568. get:
  1569. description: 获取JSON
  1570. parameters:
  1571. - description: menuName
  1572. in: query
  1573. name: menuName
  1574. type: string
  1575. responses:
  1576. "200":
  1577. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  1578. schema:
  1579. type: string
  1580. security:
  1581. - Bearer: []
  1582. summary: Menu列表数据
  1583. tags:
  1584. - 菜单
  1585. /api/v1/menurole:
  1586. get:
  1587. description: 获取JSON
  1588. parameters:
  1589. - description: id
  1590. in: path
  1591. name: id
  1592. required: true
  1593. type: integer
  1594. responses:
  1595. "200":
  1596. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  1597. schema:
  1598. type: string
  1599. security:
  1600. - Bearer: []
  1601. summary: 根据角色名称获取菜单列表数据(左菜单使用)
  1602. tags:
  1603. - 菜单
  1604. /api/v1/operlog:
  1605. post:
  1606. consumes:
  1607. - application/json
  1608. description: 获取JSON
  1609. parameters:
  1610. - description: data
  1611. in: body
  1612. name: data
  1613. required: true
  1614. schema:
  1615. $ref: '#/definitions/models.SysOperLog'
  1616. type: object
  1617. responses:
  1618. "200":
  1619. description: '{"code": -1, "message": "添加失败"}'
  1620. schema:
  1621. type: string
  1622. security:
  1623. - Bearer: []
  1624. summary: 添加操作日志
  1625. tags:
  1626. - 操作日志
  1627. /api/v1/operlog/{infoId}:
  1628. get:
  1629. description: 获取JSON
  1630. parameters:
  1631. - description: infoId
  1632. in: path
  1633. name: infoId
  1634. required: true
  1635. type: integer
  1636. responses:
  1637. "200":
  1638. description: '{"code": 200, "data": [...]}'
  1639. schema:
  1640. $ref: '#/definitions/app.Response'
  1641. security:
  1642. - Bearer: []
  1643. summary: 通过编码获取登录日志
  1644. tags:
  1645. - 登录日志
  1646. /api/v1/operlog/{operId}:
  1647. delete:
  1648. description: 删除数据
  1649. parameters:
  1650. - description: 以逗号(,)分割的operId
  1651. in: path
  1652. name: operId
  1653. required: true
  1654. type: string
  1655. responses:
  1656. "200":
  1657. description: '{"code": -1, "message": "删除失败"}'
  1658. schema:
  1659. type: string
  1660. summary: 批量删除操作日志
  1661. tags:
  1662. - 操作日志
  1663. /api/v1/operloglist:
  1664. get:
  1665. description: 获取JSON
  1666. parameters:
  1667. - description: status
  1668. in: query
  1669. name: status
  1670. type: string
  1671. - description: dictCode
  1672. in: query
  1673. name: dictCode
  1674. type: string
  1675. - description: dictType
  1676. in: query
  1677. name: dictType
  1678. type: string
  1679. - description: 页条数
  1680. in: query
  1681. name: pageSize
  1682. type: integer
  1683. - description: 页码
  1684. in: query
  1685. name: pageIndex
  1686. type: integer
  1687. responses:
  1688. "200":
  1689. description: '{"code": 200, "data": [...]}'
  1690. schema:
  1691. $ref: '#/definitions/app.Response'
  1692. security:
  1693. - Bearer: []
  1694. summary: 登录日志列表
  1695. tags:
  1696. - 登录日志
  1697. /api/v1/post:
  1698. get:
  1699. description: 获取JSON
  1700. parameters:
  1701. - description: postName
  1702. in: query
  1703. name: postName
  1704. type: string
  1705. - description: postCode
  1706. in: query
  1707. name: postCode
  1708. type: string
  1709. - description: postId
  1710. in: query
  1711. name: postId
  1712. type: string
  1713. - description: status
  1714. in: query
  1715. name: status
  1716. type: string
  1717. responses:
  1718. "200":
  1719. description: '{"code": 200, "data": [...]}'
  1720. schema:
  1721. $ref: '#/definitions/app.Response'
  1722. security:
  1723. - Bearer: []
  1724. summary: 岗位列表数据
  1725. tags:
  1726. - 岗位
  1727. post:
  1728. consumes:
  1729. - application/json
  1730. description: 获取JSON
  1731. parameters:
  1732. - description: data
  1733. in: body
  1734. name: data
  1735. required: true
  1736. schema:
  1737. $ref: '#/definitions/models.Post'
  1738. type: object
  1739. responses:
  1740. "200":
  1741. description: '{"code": -1, "message": "添加失败"}'
  1742. schema:
  1743. type: string
  1744. security:
  1745. - Bearer: []
  1746. summary: 添加岗位
  1747. tags:
  1748. - 岗位
  1749. /api/v1/post/:
  1750. put:
  1751. consumes:
  1752. - application/json
  1753. description: 获取JSON
  1754. parameters:
  1755. - description: body
  1756. in: body
  1757. name: data
  1758. required: true
  1759. schema:
  1760. $ref: '#/definitions/models.Post'
  1761. type: object
  1762. responses:
  1763. "200":
  1764. description: '{"code": -1, "message": "添加失败"}'
  1765. schema:
  1766. type: string
  1767. security:
  1768. - Bearer: []
  1769. summary: 修改岗位
  1770. tags:
  1771. - 岗位
  1772. /api/v1/post/{postId}:
  1773. delete:
  1774. description: 删除数据
  1775. parameters:
  1776. - description: id
  1777. in: path
  1778. name: id
  1779. required: true
  1780. type: integer
  1781. responses:
  1782. "200":
  1783. description: '{"code": 200, "message": "删除成功"}'
  1784. schema:
  1785. type: string
  1786. "500":
  1787. description: '{"code": 500, "message": "删除失败"}'
  1788. schema:
  1789. type: string
  1790. summary: 删除岗位
  1791. tags:
  1792. - 岗位
  1793. get:
  1794. description: 获取JSON
  1795. parameters:
  1796. - description: postId
  1797. in: path
  1798. name: postId
  1799. required: true
  1800. type: integer
  1801. responses:
  1802. "200":
  1803. description: '{"code": 200, "data": [...]}'
  1804. schema:
  1805. $ref: '#/definitions/app.Response'
  1806. security:
  1807. - Bearer: []
  1808. summary: 获取岗位信息
  1809. tags:
  1810. - 岗位
  1811. /api/v1/public/uploadFile:
  1812. post:
  1813. consumes:
  1814. - multipart/form-data
  1815. description: 获取JSON
  1816. parameters:
  1817. - description: type
  1818. in: query
  1819. name: type
  1820. required: true
  1821. type: string
  1822. - description: file
  1823. in: formData
  1824. name: file
  1825. required: true
  1826. type: file
  1827. responses:
  1828. "200":
  1829. description: '{"code": -1, "message": "添加失败"}'
  1830. schema:
  1831. type: string
  1832. summary: 上传图片
  1833. tags:
  1834. - 公共接口
  1835. /api/v1/role:
  1836. get:
  1837. description: 获取JSON
  1838. parameters:
  1839. - description: roleId
  1840. in: path
  1841. name: roleId
  1842. type: string
  1843. responses:
  1844. "200":
  1845. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  1846. schema:
  1847. type: string
  1848. security:
  1849. - Bearer: []
  1850. summary: 获取Role数据
  1851. tags:
  1852. - 角色/Role
  1853. post:
  1854. consumes:
  1855. - application/json
  1856. description: 获取JSON
  1857. parameters:
  1858. - description: data
  1859. in: body
  1860. name: data
  1861. required: true
  1862. schema:
  1863. $ref: '#/definitions/models.SysRole'
  1864. type: object
  1865. responses:
  1866. "200":
  1867. description: '{"code": -1, "message": "添加失败"}'
  1868. schema:
  1869. type: string
  1870. summary: 创建角色
  1871. tags:
  1872. - 角色/Role
  1873. put:
  1874. consumes:
  1875. - application/json
  1876. description: 获取JSON
  1877. parameters:
  1878. - description: body
  1879. in: body
  1880. name: data
  1881. required: true
  1882. schema:
  1883. $ref: '#/definitions/models.SysRole'
  1884. type: object
  1885. responses:
  1886. "200":
  1887. description: '{"code": -1, "message": "修改失败"}'
  1888. schema:
  1889. type: string
  1890. summary: 修改用户角色
  1891. tags:
  1892. - 角色/Role
  1893. /api/v1/role/{roleId}:
  1894. delete:
  1895. description: 删除数据
  1896. parameters:
  1897. - description: roleId
  1898. in: path
  1899. name: roleId
  1900. required: true
  1901. type: integer
  1902. responses:
  1903. "200":
  1904. description: '{"code": -1, "message": "删除失败"}'
  1905. schema:
  1906. type: string
  1907. summary: 删除用户角色
  1908. tags:
  1909. - 角色/Role
  1910. /api/v1/rolelist:
  1911. get:
  1912. description: Get JSON
  1913. parameters:
  1914. - description: roleName
  1915. in: query
  1916. name: roleName
  1917. type: string
  1918. - description: status
  1919. in: query
  1920. name: status
  1921. type: string
  1922. - description: roleKey
  1923. in: query
  1924. name: roleKey
  1925. type: string
  1926. - description: 页条数
  1927. in: query
  1928. name: pageSize
  1929. type: integer
  1930. - description: 页码
  1931. in: query
  1932. name: pageIndex
  1933. type: integer
  1934. responses:
  1935. "200":
  1936. description: '{"code": 200, "data": [...]}'
  1937. schema:
  1938. $ref: '#/definitions/app.Response'
  1939. security:
  1940. - Bearer: []
  1941. summary: 角色列表数据
  1942. tags:
  1943. - 角色/Role
  1944. /api/v1/rolemenu:
  1945. get:
  1946. description: 获取JSON
  1947. parameters:
  1948. - description: RoleId
  1949. in: query
  1950. name: RoleId
  1951. type: string
  1952. responses:
  1953. "200":
  1954. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  1955. schema:
  1956. type: string
  1957. security:
  1958. - Bearer: []
  1959. summary: RoleMenu列表数据
  1960. tags:
  1961. - 角色菜单
  1962. /api/v1/rolemenu/{id}:
  1963. delete:
  1964. description: 删除数据
  1965. parameters:
  1966. - description: id
  1967. in: path
  1968. name: id
  1969. required: true
  1970. type: string
  1971. - description: menu_id
  1972. in: query
  1973. name: menu_id
  1974. type: string
  1975. responses:
  1976. "200":
  1977. description: '{"code": -1, "message": "删除失败"}'
  1978. schema:
  1979. type: string
  1980. summary: 删除用户菜单数据
  1981. tags:
  1982. - 角色菜单
  1983. /api/v1/setting:
  1984. get:
  1985. description: 获取JSON
  1986. responses:
  1987. "200":
  1988. description: '{"code": -1, "message": "添加失败"}'
  1989. schema:
  1990. type: string
  1991. summary: 查询系统信息
  1992. tags:
  1993. - 系统信息
  1994. /api/v1/settings/serverInfo:
  1995. get:
  1996. description: 获取JSON
  1997. responses:
  1998. "200":
  1999. description: '{"code": 200, "data": [...]}'
  2000. schema:
  2001. $ref: '#/definitions/app.Response'
  2002. summary: 系统信息
  2003. tags:
  2004. - 系统信息
  2005. /api/v1/sys/tables/info:
  2006. post:
  2007. consumes:
  2008. - application/json
  2009. description: 添加表结构
  2010. parameters:
  2011. - description: tableName / 数据表名称
  2012. in: query
  2013. name: tables
  2014. type: string
  2015. responses:
  2016. "200":
  2017. description: '{"code": -1, "message": "添加失败"}'
  2018. schema:
  2019. type: string
  2020. security:
  2021. - Bearer: []
  2022. summary: 添加表结构
  2023. tags:
  2024. - 工具 - 生成表
  2025. put:
  2026. consumes:
  2027. - application/json
  2028. description: 修改表结构
  2029. parameters:
  2030. - description: body
  2031. in: body
  2032. name: data
  2033. required: true
  2034. schema:
  2035. $ref: '#/definitions/tools.SysTables'
  2036. type: object
  2037. responses:
  2038. "200":
  2039. description: '{"code": -1, "message": "添加失败"}'
  2040. schema:
  2041. type: string
  2042. security:
  2043. - Bearer: []
  2044. summary: 修改表结构
  2045. tags:
  2046. - 工具 - 生成表
  2047. /api/v1/sys/tables/info/{tableId}:
  2048. delete:
  2049. description: 删除表结构
  2050. parameters:
  2051. - description: tableId
  2052. in: path
  2053. name: tableId
  2054. required: true
  2055. type: integer
  2056. responses:
  2057. "200":
  2058. description: '{"code": -1, "message": "删除失败"}'
  2059. schema:
  2060. type: string
  2061. summary: 删除表结构
  2062. tags:
  2063. - 工具 - 生成表
  2064. get:
  2065. description: 获取JSON
  2066. parameters:
  2067. - description: configKey
  2068. in: path
  2069. name: configKey
  2070. required: true
  2071. type: integer
  2072. responses:
  2073. "200":
  2074. description: '{"code": 200, "data": [...]}'
  2075. schema:
  2076. $ref: '#/definitions/app.Response'
  2077. security:
  2078. - Bearer: []
  2079. summary: 获取配置
  2080. tags:
  2081. - 工具 - 生成表
  2082. /api/v1/sys/tables/page:
  2083. get:
  2084. description: 生成表分页列表
  2085. parameters:
  2086. - description: tableName / 数据表名称
  2087. in: query
  2088. name: tableName
  2089. type: string
  2090. - description: pageSize / 页条数
  2091. in: query
  2092. name: pageSize
  2093. type: integer
  2094. - description: pageIndex / 页码
  2095. in: query
  2096. name: pageIndex
  2097. type: integer
  2098. responses:
  2099. "200":
  2100. description: '{"code": 200, "data": [...]}'
  2101. schema:
  2102. $ref: '#/definitions/app.Response'
  2103. summary: 分页列表数据
  2104. tags:
  2105. - 工具 - 生成表
  2106. /api/v1/sysUser:
  2107. get:
  2108. description: 获取JSON
  2109. responses:
  2110. "200":
  2111. description: '{"code": 200, "data": [...]}'
  2112. schema:
  2113. $ref: '#/definitions/app.Response'
  2114. security:
  2115. - Bearer: []
  2116. summary: 获取用户角色和职位
  2117. tags:
  2118. - 用户
  2119. post:
  2120. consumes:
  2121. - application/json
  2122. description: 获取JSON
  2123. parameters:
  2124. - description: 用户数据
  2125. in: body
  2126. name: data
  2127. required: true
  2128. schema:
  2129. $ref: '#/definitions/models.SysUser'
  2130. type: object
  2131. responses:
  2132. "200":
  2133. description: '{"code": -1, "message": "添加失败"}'
  2134. schema:
  2135. type: string
  2136. summary: 创建用户
  2137. tags:
  2138. - 用户
  2139. /api/v1/sysUser/{userId}:
  2140. get:
  2141. description: 获取JSON
  2142. parameters:
  2143. - description: 用户编码
  2144. in: path
  2145. name: userId
  2146. required: true
  2147. type: integer
  2148. responses:
  2149. "200":
  2150. description: '{"code": 200, "data": [...]}'
  2151. schema:
  2152. $ref: '#/definitions/app.Response'
  2153. security:
  2154. - Bearer: []
  2155. summary: 获取用户
  2156. tags:
  2157. - 用户
  2158. /api/v1/sysUserList:
  2159. get:
  2160. description: 获取JSON
  2161. parameters:
  2162. - description: username
  2163. in: query
  2164. name: username
  2165. type: string
  2166. responses:
  2167. "200":
  2168. description: '{"code": -1, "message": "抱歉未找到相关信息"}'
  2169. schema:
  2170. type: string
  2171. security:
  2172. - Bearer: []
  2173. summary: 列表用户信息数据
  2174. tags:
  2175. - 用户
  2176. /api/v1/syscategory:
  2177. post:
  2178. consumes:
  2179. - application/json
  2180. description: 获取JSON
  2181. parameters:
  2182. - description: data
  2183. in: body
  2184. name: data
  2185. required: true
  2186. schema:
  2187. $ref: '#/definitions/models.SysCategory'
  2188. type: object
  2189. responses:
  2190. "200":
  2191. description: '{"code": -1, "message": "添加失败"}'
  2192. schema:
  2193. type: string
  2194. summary: 添加分类
  2195. tags:
  2196. - 分类
  2197. /api/v1/syscontent:
  2198. post:
  2199. consumes:
  2200. - application/json
  2201. description: 获取JSON
  2202. parameters:
  2203. - description: data
  2204. in: body
  2205. name: data
  2206. required: true
  2207. schema:
  2208. $ref: '#/definitions/models.SysContent'
  2209. type: object
  2210. responses:
  2211. "200":
  2212. description: '{"code": -1, "message": "添加失败"}'
  2213. schema:
  2214. type: string
  2215. summary: 添加内容管理
  2216. tags:
  2217. - 内容管理
  2218. /api/v1/sysfiledir:
  2219. post:
  2220. consumes:
  2221. - application/json
  2222. description: 获取JSON
  2223. parameters:
  2224. - description: data
  2225. in: body
  2226. name: data
  2227. required: true
  2228. schema:
  2229. $ref: '#/definitions/models.SysFileDir'
  2230. type: object
  2231. responses:
  2232. "200":
  2233. description: '{"code": -1, "message": "添加失败"}'
  2234. schema:
  2235. type: string
  2236. summary: 添加SysFileDir
  2237. tags:
  2238. - SysFileDir
  2239. /api/v1/system/setting:
  2240. post:
  2241. description: 获取JSON
  2242. parameters:
  2243. - description: body
  2244. in: body
  2245. name: data
  2246. required: true
  2247. schema:
  2248. $ref: '#/definitions/models.SysUser'
  2249. type: object
  2250. responses:
  2251. "200":
  2252. description: '{"code": -1, "message": "添加失败"}'
  2253. schema:
  2254. type: string
  2255. summary: 更新或提交系统信息
  2256. tags:
  2257. - 系统信息
  2258. /api/v1/sysuser/{userId}:
  2259. delete:
  2260. description: 删除数据
  2261. parameters:
  2262. - description: userId
  2263. in: path
  2264. name: userId
  2265. required: true
  2266. type: integer
  2267. responses:
  2268. "200":
  2269. description: '{"code": -1, "message": "删除失败"}'
  2270. schema:
  2271. type: string
  2272. summary: 删除用户数据
  2273. tags:
  2274. - 用户
  2275. put:
  2276. consumes:
  2277. - application/json
  2278. description: 获取JSON
  2279. parameters:
  2280. - description: body
  2281. in: body
  2282. name: data
  2283. required: true
  2284. schema:
  2285. $ref: '#/definitions/models.SysUser'
  2286. type: object
  2287. responses:
  2288. "200":
  2289. description: '{"code": -1, "message": "修改失败"}'
  2290. schema:
  2291. type: string
  2292. summary: 修改用户数据
  2293. tags:
  2294. - 用户
  2295. /api/v1/user/profile:
  2296. get:
  2297. description: 获取JSON
  2298. responses:
  2299. "200":
  2300. description: '{"code": 200, "data": [...]}'
  2301. schema:
  2302. $ref: '#/definitions/app.Response'
  2303. security:
  2304. - Bearer: []
  2305. summary: 获取个人中心用户
  2306. tags:
  2307. - 个人中心
  2308. /api/v1/user/profileAvatar:
  2309. post:
  2310. consumes:
  2311. - multipart/form-data
  2312. description: 获取JSON
  2313. parameters:
  2314. - description: file
  2315. in: formData
  2316. name: file
  2317. required: true
  2318. type: file
  2319. responses:
  2320. "200":
  2321. description: '{"code": -1, "message": "添加失败"}'
  2322. schema:
  2323. type: string
  2324. summary: 修改头像
  2325. tags:
  2326. - 用户
  2327. /login:
  2328. post:
  2329. consumes:
  2330. - application/json
  2331. description: |-
  2332. 获取token
  2333. LoginHandler can be used by clients to get a jwt token.
  2334. Payload needs to be json in the form of {"username": "USERNAME", "password": "PASSWORD"}.
  2335. Reply will be of the form {"token": "TOKEN"}.
  2336. dev mode:It should be noted that all fields cannot be empty, and a value of 0 can be passed in addition to the account password
  2337. 注意:开发模式:需要注意全部字段不能为空,账号密码外可以传入0值
  2338. parameters:
  2339. - description: account
  2340. in: body
  2341. name: account
  2342. required: true
  2343. schema:
  2344. $ref: '#/definitions/models.Login'
  2345. type: object
  2346. responses:
  2347. "200":
  2348. description: '{"code": 200, "expire": "2019-08-07T12:45:48+08:00", "token":
  2349. ".eyJleHAiOjE1NjUxNTMxNDgsImlkIjoiYWRtaW4iLCJvcmlnX2lhdCI6MTU2NTE0OTU0OH0.-zvzHvbg0A"
  2350. }'
  2351. schema:
  2352. type: string
  2353. summary: 登陆
  2354. /logout:
  2355. post:
  2356. consumes:
  2357. - application/json
  2358. description: 获取token
  2359. responses:
  2360. "200":
  2361. description: '{"code": 200, "msg": "成功退出系统" }'
  2362. schema:
  2363. type: string
  2364. security:
  2365. - Bearer: []
  2366. summary: 退出登录
  2367. /sd/cpu:
  2368. get:
  2369. consumes:
  2370. - text/html
  2371. description: CPU 使用量 DiskCheck checks the disk usage.
  2372. produces:
  2373. - text/html
  2374. responses:
  2375. "200":
  2376. description: OK
  2377. schema:
  2378. type: string
  2379. summary: CPU 使用量
  2380. /sd/disk:
  2381. get:
  2382. consumes:
  2383. - text/html
  2384. description: 服务器硬盘使用量 DiskCheck checks the disk usage.
  2385. produces:
  2386. - text/html
  2387. responses:
  2388. "200":
  2389. description: 'OK - Free space: 16321MB (15GB) / 51200MB (50GB) | Used: 31%'
  2390. schema:
  2391. type: string
  2392. "429":
  2393. description: WARNING
  2394. schema:
  2395. type: string
  2396. "500":
  2397. description: CRITICAL
  2398. schema:
  2399. type: string
  2400. summary: 服务器硬盘使用量
  2401. /sd/health:
  2402. get:
  2403. consumes:
  2404. - text/html
  2405. description: 健康状况
  2406. produces:
  2407. - text/html
  2408. responses:
  2409. "200":
  2410. description: OK
  2411. schema:
  2412. type: string
  2413. summary: 健康状况 HealthCheck shows OK as the ping-pong result.
  2414. /sd/os:
  2415. get:
  2416. consumes:
  2417. - text/html
  2418. description: Os
  2419. produces:
  2420. - text/html
  2421. responses:
  2422. "200":
  2423. description: OK
  2424. schema:
  2425. type: string
  2426. summary: OS
  2427. /sd/ram:
  2428. get:
  2429. consumes:
  2430. - text/html
  2431. description: 内存使用量 RAMCheck checks the disk usage.
  2432. produces:
  2433. - text/html
  2434. responses:
  2435. "200":
  2436. description: OK
  2437. schema:
  2438. type: string
  2439. summary: 内存使用量
  2440. securityDefinitions:
  2441. Bearer:
  2442. in: header
  2443. name: Authorization
  2444. type: apiKey
  2445. swagger: "2.0"