swagger.yaml 103 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418341934203421342234233424342534263427342834293430343134323433343434353436343734383439344034413442344334443445344634473448344934503451345234533454345534563457345834593460346134623463346434653466346734683469347034713472347334743475347634773478347934803481348234833484348534863487348834893490349134923493349434953496349734983499350035013502350335043505350635073508350935103511351235133514351535163517351835193520352135223523352435253526352735283529353035313532353335343535353635373538353935403541354235433544354535463547354835493550355135523553355435553556355735583559356035613562356335643565356635673568356935703571357235733574357535763577357835793580358135823583358435853586358735883589359035913592359335943595359635973598359936003601360236033604360536063607360836093610361136123613361436153616361736183619362036213622362336243625362636273628362936303631363236333634363536363637363836393640364136423643364436453646364736483649365036513652365336543655365636573658365936603661366236633664366536663667366836693670367136723673367436753676367736783679368036813682368336843685368636873688368936903691369236933694369536963697369836993700370137023703370437053706370737083709371037113712371337143715371637173718371937203721372237233724372537263727372837293730373137323733373437353736373737383739374037413742374337443745374637473748374937503751375237533754375537563757375837593760376137623763376437653766376737683769377037713772377337743775377637773778377937803781378237833784378537863787378837893790379137923793379437953796379737983799380038013802380338043805380638073808380938103811381238133814381538163817381838193820382138223823382438253826382738283829383038313832383338343835383638373838383938403841384238433844384538463847384838493850385138523853385438553856385738583859386038613862386338643865386638673868386938703871387238733874387538763877387838793880388138823883388438853886388738883889389038913892389338943895389638973898389939003901390239033904390539063907390839093910391139123913391439153916391739183919392039213922392339243925392639273928392939303931393239333934393539363937393839393940394139423943394439453946394739483949395039513952395339543955395639573958395939603961396239633964396539663967396839693970397139723973397439753976397739783979398039813982398339843985398639873988398939903991399239933994399539963997399839994000400140024003400440054006400740084009401040114012401340144015401640174018401940204021402240234024402540264027402840294030403140324033403440354036403740384039404040414042404340444045404640474048404940504051405240534054405540564057405840594060406140624063406440654066406740684069407040714072407340744075407640774078407940804081408240834084408540864087408840894090409140924093409440954096409740984099410041014102410341044105410641074108410941104111411241134114411541164117411841194120412141224123412441254126412741284129413041314132413341344135413641374138413941404141414241434144414541464147414841494150415141524153415441554156415741584159416041614162416341644165416641674168416941704171417241734174417541764177417841794180418141824183418441854186418741884189419041914192419341944195419641974198419942004201420242034204420542064207420842094210421142124213421442154216421742184219422042214222422342244225422642274228422942304231423242334234423542364237423842394240424142424243424442454246424742484249425042514252425342544255425642574258425942604261426242634264426542664267426842694270427142724273427442754276427742784279
  1. definitions:
  2. config.AliyunOSS:
  3. properties:
  4. access-key-id:
  5. type: string
  6. access-key-secret:
  7. type: string
  8. base-path:
  9. type: string
  10. bucket-name:
  11. type: string
  12. bucket-url:
  13. type: string
  14. endpoint:
  15. type: string
  16. type: object
  17. config.Autocode:
  18. properties:
  19. root:
  20. type: string
  21. server:
  22. type: string
  23. server-api:
  24. type: string
  25. server-initialize:
  26. type: string
  27. server-model:
  28. type: string
  29. server-plug:
  30. type: string
  31. server-request:
  32. type: string
  33. server-router:
  34. type: string
  35. server-service:
  36. type: string
  37. transfer-restart:
  38. type: boolean
  39. web:
  40. type: string
  41. web-api:
  42. type: string
  43. web-form:
  44. type: string
  45. web-table:
  46. type: string
  47. type: object
  48. config.AwsS3:
  49. properties:
  50. base-url:
  51. type: string
  52. bucket:
  53. type: string
  54. disable-ssl:
  55. type: boolean
  56. endpoint:
  57. type: string
  58. path-prefix:
  59. type: string
  60. region:
  61. type: string
  62. s3-force-path-style:
  63. type: boolean
  64. secret-id:
  65. type: string
  66. secret-key:
  67. type: string
  68. type: object
  69. config.CORS:
  70. properties:
  71. mode:
  72. type: string
  73. whitelist:
  74. items:
  75. $ref: '#/definitions/config.CORSWhitelist'
  76. type: array
  77. type: object
  78. config.CORSWhitelist:
  79. properties:
  80. allow-credentials:
  81. type: boolean
  82. allow-headers:
  83. type: string
  84. allow-methods:
  85. type: string
  86. allow-origin:
  87. type: string
  88. expose-headers:
  89. type: string
  90. type: object
  91. config.Captcha:
  92. properties:
  93. img-height:
  94. description: 验证码高度
  95. type: integer
  96. img-width:
  97. description: 验证码宽度
  98. type: integer
  99. key-long:
  100. description: 验证码长度
  101. type: integer
  102. open-captcha:
  103. description: 防爆破验证码开启此数,0代表每次登录都需要验证码,其他数字代表错误密码此数,如3代表错误三次后出现验证码
  104. type: integer
  105. open-captcha-timeout:
  106. description: 防爆破验证码超时时间,单位:s(秒)
  107. type: integer
  108. type: object
  109. config.Excel:
  110. properties:
  111. dir:
  112. type: string
  113. type: object
  114. config.HuaWeiObs:
  115. properties:
  116. access-key:
  117. type: string
  118. bucket:
  119. type: string
  120. endpoint:
  121. type: string
  122. path:
  123. type: string
  124. secret-key:
  125. type: string
  126. type: object
  127. config.JWT:
  128. properties:
  129. buffer-time:
  130. description: 缓冲时间
  131. type: string
  132. expires-time:
  133. description: 过期时间
  134. type: string
  135. issuer:
  136. description: 签发者
  137. type: string
  138. signing-key:
  139. description: jwt签名
  140. type: string
  141. type: object
  142. config.Local:
  143. properties:
  144. path:
  145. description: 本地文件访问路径
  146. type: string
  147. store-path:
  148. description: 本地文件存储路径
  149. type: string
  150. type: object
  151. config.Mongo:
  152. properties:
  153. coll:
  154. description: collection name
  155. type: string
  156. connect-timeout-ms:
  157. description: 连接超时时间
  158. type: integer
  159. database:
  160. description: database name
  161. type: string
  162. hosts:
  163. description: 主机列表
  164. items:
  165. $ref: '#/definitions/config.MongoHost'
  166. type: array
  167. is-zap:
  168. description: 是否开启zap日志
  169. type: boolean
  170. max-pool-size:
  171. description: 最大连接池
  172. type: integer
  173. min-pool-size:
  174. description: 最小连接池
  175. type: integer
  176. options:
  177. description: mongodb options
  178. type: string
  179. password:
  180. description: 密码
  181. type: string
  182. socket-timeout-ms:
  183. description: socket超时时间
  184. type: integer
  185. username:
  186. description: 用户名
  187. type: string
  188. type: object
  189. config.MongoHost:
  190. properties:
  191. host:
  192. description: ip地址
  193. type: string
  194. port:
  195. description: 端口
  196. type: string
  197. type: object
  198. config.Mssql:
  199. properties:
  200. config:
  201. description: 高级配置
  202. type: string
  203. db-name:
  204. description: 数据库名
  205. type: string
  206. engine:
  207. default: InnoDB
  208. description: 数据库引擎,默认InnoDB
  209. type: string
  210. log-mode:
  211. description: 是否开启Gorm全局日志
  212. type: string
  213. log-zap:
  214. description: 是否通过zap写入日志文件
  215. type: boolean
  216. max-idle-conns:
  217. description: 空闲中的最大连接数
  218. type: integer
  219. max-open-conns:
  220. description: 打开到数据库的最大连接数
  221. type: integer
  222. password:
  223. description: 数据库密码
  224. type: string
  225. path:
  226. type: string
  227. port:
  228. type: string
  229. prefix:
  230. type: string
  231. singular:
  232. description: 是否开启全局禁用复数,true表示开启
  233. type: boolean
  234. username:
  235. description: 数据库密码
  236. type: string
  237. type: object
  238. config.Mysql:
  239. properties:
  240. config:
  241. description: 高级配置
  242. type: string
  243. db-name:
  244. description: 数据库名
  245. type: string
  246. engine:
  247. default: InnoDB
  248. description: 数据库引擎,默认InnoDB
  249. type: string
  250. log-mode:
  251. description: 是否开启Gorm全局日志
  252. type: string
  253. log-zap:
  254. description: 是否通过zap写入日志文件
  255. type: boolean
  256. max-idle-conns:
  257. description: 空闲中的最大连接数
  258. type: integer
  259. max-open-conns:
  260. description: 打开到数据库的最大连接数
  261. type: integer
  262. password:
  263. description: 数据库密码
  264. type: string
  265. path:
  266. type: string
  267. port:
  268. type: string
  269. prefix:
  270. type: string
  271. singular:
  272. description: 是否开启全局禁用复数,true表示开启
  273. type: boolean
  274. username:
  275. description: 数据库密码
  276. type: string
  277. type: object
  278. config.Oracle:
  279. properties:
  280. config:
  281. description: 高级配置
  282. type: string
  283. db-name:
  284. description: 数据库名
  285. type: string
  286. engine:
  287. default: InnoDB
  288. description: 数据库引擎,默认InnoDB
  289. type: string
  290. log-mode:
  291. description: 是否开启Gorm全局日志
  292. type: string
  293. log-zap:
  294. description: 是否通过zap写入日志文件
  295. type: boolean
  296. max-idle-conns:
  297. description: 空闲中的最大连接数
  298. type: integer
  299. max-open-conns:
  300. description: 打开到数据库的最大连接数
  301. type: integer
  302. password:
  303. description: 数据库密码
  304. type: string
  305. path:
  306. type: string
  307. port:
  308. type: string
  309. prefix:
  310. type: string
  311. singular:
  312. description: 是否开启全局禁用复数,true表示开启
  313. type: boolean
  314. username:
  315. description: 数据库密码
  316. type: string
  317. type: object
  318. config.Pgsql:
  319. properties:
  320. config:
  321. description: 高级配置
  322. type: string
  323. db-name:
  324. description: 数据库名
  325. type: string
  326. engine:
  327. default: InnoDB
  328. description: 数据库引擎,默认InnoDB
  329. type: string
  330. log-mode:
  331. description: 是否开启Gorm全局日志
  332. type: string
  333. log-zap:
  334. description: 是否通过zap写入日志文件
  335. type: boolean
  336. max-idle-conns:
  337. description: 空闲中的最大连接数
  338. type: integer
  339. max-open-conns:
  340. description: 打开到数据库的最大连接数
  341. type: integer
  342. password:
  343. description: 数据库密码
  344. type: string
  345. path:
  346. type: string
  347. port:
  348. type: string
  349. prefix:
  350. type: string
  351. singular:
  352. description: 是否开启全局禁用复数,true表示开启
  353. type: boolean
  354. username:
  355. description: 数据库密码
  356. type: string
  357. type: object
  358. config.Qiniu:
  359. properties:
  360. access-key:
  361. description: 秘钥AK
  362. type: string
  363. bucket:
  364. description: 空间名称
  365. type: string
  366. img-path:
  367. description: CDN加速域名
  368. type: string
  369. secret-key:
  370. description: 秘钥SK
  371. type: string
  372. use-cdn-domains:
  373. description: 上传是否使用CDN上传加速
  374. type: boolean
  375. use-https:
  376. description: 是否使用https
  377. type: boolean
  378. zone:
  379. description: 存储区域
  380. type: string
  381. type: object
  382. config.Redis:
  383. properties:
  384. addr:
  385. description: 服务器地址:端口
  386. type: string
  387. db:
  388. description: redis的哪个数据库
  389. type: integer
  390. password:
  391. description: 密码
  392. type: string
  393. type: object
  394. config.Server:
  395. properties:
  396. aliyun-oss:
  397. $ref: '#/definitions/config.AliyunOSS'
  398. autocode:
  399. allOf:
  400. - $ref: '#/definitions/config.Autocode'
  401. description: auto
  402. aws-s3:
  403. $ref: '#/definitions/config.AwsS3'
  404. captcha:
  405. $ref: '#/definitions/config.Captcha'
  406. cors:
  407. allOf:
  408. - $ref: '#/definitions/config.CORS'
  409. description: 跨域配置
  410. db-list:
  411. items:
  412. $ref: '#/definitions/config.SpecializedDB'
  413. type: array
  414. email:
  415. $ref: '#/definitions/github_com_flipped-aurora_gin-vue-admin_server_config.Email'
  416. excel:
  417. $ref: '#/definitions/config.Excel'
  418. hua-wei-obs:
  419. $ref: '#/definitions/config.HuaWeiObs'
  420. jwt:
  421. $ref: '#/definitions/config.JWT'
  422. local:
  423. allOf:
  424. - $ref: '#/definitions/config.Local'
  425. description: oss
  426. mongo:
  427. $ref: '#/definitions/config.Mongo'
  428. mssql:
  429. $ref: '#/definitions/config.Mssql'
  430. mysql:
  431. allOf:
  432. - $ref: '#/definitions/config.Mysql'
  433. description: gorm
  434. oracle:
  435. $ref: '#/definitions/config.Oracle'
  436. pgsql:
  437. $ref: '#/definitions/config.Pgsql'
  438. qiniu:
  439. $ref: '#/definitions/config.Qiniu'
  440. redis:
  441. $ref: '#/definitions/config.Redis'
  442. sqlite:
  443. $ref: '#/definitions/config.Sqlite'
  444. system:
  445. $ref: '#/definitions/config.System'
  446. tencent-cos:
  447. $ref: '#/definitions/config.TencentCOS'
  448. zap:
  449. $ref: '#/definitions/config.Zap'
  450. type: object
  451. config.SpecializedDB:
  452. properties:
  453. alias-name:
  454. type: string
  455. config:
  456. description: 高级配置
  457. type: string
  458. db-name:
  459. description: 数据库名
  460. type: string
  461. disable:
  462. type: boolean
  463. engine:
  464. default: InnoDB
  465. description: 数据库引擎,默认InnoDB
  466. type: string
  467. log-mode:
  468. description: 是否开启Gorm全局日志
  469. type: string
  470. log-zap:
  471. description: 是否通过zap写入日志文件
  472. type: boolean
  473. max-idle-conns:
  474. description: 空闲中的最大连接数
  475. type: integer
  476. max-open-conns:
  477. description: 打开到数据库的最大连接数
  478. type: integer
  479. password:
  480. description: 数据库密码
  481. type: string
  482. path:
  483. type: string
  484. port:
  485. type: string
  486. prefix:
  487. type: string
  488. singular:
  489. description: 是否开启全局禁用复数,true表示开启
  490. type: boolean
  491. type:
  492. type: string
  493. username:
  494. description: 数据库密码
  495. type: string
  496. type: object
  497. config.Sqlite:
  498. properties:
  499. config:
  500. description: 高级配置
  501. type: string
  502. db-name:
  503. description: 数据库名
  504. type: string
  505. engine:
  506. default: InnoDB
  507. description: 数据库引擎,默认InnoDB
  508. type: string
  509. log-mode:
  510. description: 是否开启Gorm全局日志
  511. type: string
  512. log-zap:
  513. description: 是否通过zap写入日志文件
  514. type: boolean
  515. max-idle-conns:
  516. description: 空闲中的最大连接数
  517. type: integer
  518. max-open-conns:
  519. description: 打开到数据库的最大连接数
  520. type: integer
  521. password:
  522. description: 数据库密码
  523. type: string
  524. path:
  525. type: string
  526. port:
  527. type: string
  528. prefix:
  529. type: string
  530. singular:
  531. description: 是否开启全局禁用复数,true表示开启
  532. type: boolean
  533. username:
  534. description: 数据库密码
  535. type: string
  536. type: object
  537. config.System:
  538. properties:
  539. addr:
  540. description: 端口值
  541. type: integer
  542. db-type:
  543. description: 数据库类型:mysql(默认)|sqlite|sqlserver|postgresql
  544. type: string
  545. env:
  546. description: 环境值
  547. type: string
  548. iplimit-count:
  549. type: integer
  550. iplimit-time:
  551. type: integer
  552. oss-type:
  553. description: Oss类型
  554. type: string
  555. router-prefix:
  556. type: string
  557. use-mongo:
  558. description: 使用redis
  559. type: boolean
  560. use-multipoint:
  561. description: 多点登录拦截
  562. type: boolean
  563. use-redis:
  564. description: 使用redis
  565. type: boolean
  566. type: object
  567. config.TencentCOS:
  568. properties:
  569. base-url:
  570. type: string
  571. bucket:
  572. type: string
  573. path-prefix:
  574. type: string
  575. region:
  576. type: string
  577. secret-id:
  578. type: string
  579. secret-key:
  580. type: string
  581. type: object
  582. config.Zap:
  583. properties:
  584. director:
  585. description: 日志文件夹
  586. type: string
  587. encode-level:
  588. description: 编码级
  589. type: string
  590. format:
  591. description: 输出
  592. type: string
  593. level:
  594. description: 级别
  595. type: string
  596. log-in-console:
  597. description: 输出控制台
  598. type: boolean
  599. max-age:
  600. description: 日志留存时间
  601. type: integer
  602. prefix:
  603. description: 日志前缀
  604. type: string
  605. show-line:
  606. description: 显示行
  607. type: boolean
  608. stacktrace-key:
  609. description: 栈名
  610. type: string
  611. type: object
  612. example.ExaCustomer:
  613. properties:
  614. ID:
  615. description: 主键ID
  616. type: integer
  617. createdAt:
  618. description: 创建时间
  619. type: string
  620. customerName:
  621. description: 客户名
  622. type: string
  623. customerPhoneData:
  624. description: 客户手机号
  625. type: string
  626. sysUser:
  627. allOf:
  628. - $ref: '#/definitions/system.SysUser'
  629. description: 管理详情
  630. sysUserAuthorityID:
  631. description: 管理角色ID
  632. type: integer
  633. sysUserId:
  634. description: 管理ID
  635. type: integer
  636. updatedAt:
  637. description: 更新时间
  638. type: string
  639. type: object
  640. example.ExaFile:
  641. properties:
  642. ID:
  643. description: 主键ID
  644. type: integer
  645. chunkTotal:
  646. type: integer
  647. createdAt:
  648. description: 创建时间
  649. type: string
  650. exaFileChunk:
  651. items:
  652. $ref: '#/definitions/example.ExaFileChunk'
  653. type: array
  654. deptMd5:
  655. type: string
  656. deptName:
  657. type: string
  658. deptPath:
  659. type: string
  660. isFinish:
  661. type: boolean
  662. updatedAt:
  663. description: 更新时间
  664. type: string
  665. type: object
  666. example.ExaFileChunk:
  667. properties:
  668. ID:
  669. description: 主键ID
  670. type: integer
  671. createdAt:
  672. description: 创建时间
  673. type: string
  674. exaFileID:
  675. type: integer
  676. deptChunkNumber:
  677. type: integer
  678. deptChunkPath:
  679. type: string
  680. updatedAt:
  681. description: 更新时间
  682. type: string
  683. type: object
  684. example.ExaFileUploadAndDownload:
  685. properties:
  686. ID:
  687. description: 主键ID
  688. type: integer
  689. createdAt:
  690. description: 创建时间
  691. type: string
  692. key:
  693. description: 编号
  694. type: string
  695. name:
  696. description: 文件名
  697. type: string
  698. tag:
  699. description: 文件标签
  700. type: string
  701. updatedAt:
  702. description: 更新时间
  703. type: string
  704. url:
  705. description: 文件地址
  706. type: string
  707. type: object
  708. github_com_flipped-aurora_gin-vue-admin_server_config.Email:
  709. properties:
  710. from:
  711. description: 发件人 你自己要发邮件的邮箱
  712. type: string
  713. host:
  714. description: 服务器地址 例如 smtp.qq.com 请前往QQ或者你要发邮件的邮箱查看其smtp协议
  715. type: string
  716. is-ssl:
  717. description: 是否SSL 是否开启SSL
  718. type: boolean
  719. nickname:
  720. description: 昵称 发件人昵称 通常为自己的邮箱
  721. type: string
  722. port:
  723. description: 端口 请前往QQ或者你要发邮件的邮箱查看其smtp协议 大多为 465
  724. type: integer
  725. secret:
  726. description: 密钥 用于登录的密钥 最好不要用邮箱密码 去邮箱smtp申请一个用于登录的密钥
  727. type: string
  728. to:
  729. description: 收件人:多个以英文逗号分隔 例:a@qq.com b@qq.com 正式开发中请把此项目作为参数使用
  730. type: string
  731. type: object
  732. request.AddMenuAuthorityInfo:
  733. properties:
  734. authorityId:
  735. description: 角色ID
  736. type: integer
  737. menus:
  738. items:
  739. $ref: '#/definitions/system.SysBaseMenu'
  740. type: array
  741. type: object
  742. request.CasbinInReceive:
  743. properties:
  744. authorityId:
  745. description: 权限id
  746. type: integer
  747. casbinInfos:
  748. items:
  749. $ref: '#/definitions/request.CasbinInfo'
  750. type: array
  751. type: object
  752. request.CasbinInfo:
  753. properties:
  754. method:
  755. description: 方法
  756. type: string
  757. path:
  758. description: 路径
  759. type: string
  760. type: object
  761. request.ChangePasswordReq:
  762. properties:
  763. newPassword:
  764. description: 新密码
  765. type: string
  766. password:
  767. description: 密码
  768. type: string
  769. type: object
  770. request.Empty:
  771. type: object
  772. request.GetAuthorityId:
  773. properties:
  774. authorityId:
  775. description: 角色ID
  776. type: integer
  777. type: object
  778. request.GetById:
  779. properties:
  780. id:
  781. description: 主键ID
  782. type: integer
  783. type: object
  784. request.IdsReq:
  785. properties:
  786. ids:
  787. items:
  788. type: integer
  789. type: array
  790. type: object
  791. request.InitDB:
  792. properties:
  793. dbName:
  794. description: 数据库名
  795. type: string
  796. dbPath:
  797. description: sqlite数据库文件路径
  798. type: string
  799. dbType:
  800. description: 数据库类型
  801. type: string
  802. host:
  803. description: 服务器地址
  804. type: string
  805. password:
  806. description: 数据库密码
  807. type: string
  808. port:
  809. description: 数据库连接端口
  810. type: string
  811. userName:
  812. description: 数据库用户名
  813. type: string
  814. required:
  815. - dbName
  816. type: object
  817. request.Login:
  818. properties:
  819. captcha:
  820. description: 验证码
  821. type: string
  822. captchaId:
  823. description: 验证码ID
  824. type: string
  825. password:
  826. description: 密码
  827. type: string
  828. username:
  829. description: 用户名
  830. type: string
  831. type: object
  832. request.PageInfo:
  833. properties:
  834. keyword:
  835. description: 关键字
  836. type: string
  837. page:
  838. description: 页码
  839. type: integer
  840. pageSize:
  841. description: 每页大小
  842. type: integer
  843. type: object
  844. request.Register:
  845. properties:
  846. authorityId:
  847. example: int 角色id
  848. type: string
  849. authorityIds:
  850. example: '[]uint 角色id'
  851. type: string
  852. email:
  853. example: 电子邮箱
  854. type: string
  855. enable:
  856. example: int 是否启用
  857. type: string
  858. headerImg:
  859. example: 头像链接
  860. type: string
  861. nickName:
  862. example: 昵称
  863. type: string
  864. passWord:
  865. example: 密码
  866. type: string
  867. phone:
  868. example: 电话号码
  869. type: string
  870. userName:
  871. example: 用户名
  872. type: string
  873. type: object
  874. request.RollBack:
  875. properties:
  876. deleteTable:
  877. description: 是否删除表
  878. type: boolean
  879. id:
  880. description: 主键ID
  881. type: integer
  882. type: object
  883. request.SearchApiParams:
  884. properties:
  885. ID:
  886. description: 主键ID
  887. type: integer
  888. apiGroup:
  889. description: api组
  890. type: string
  891. createdAt:
  892. description: 创建时间
  893. type: string
  894. desc:
  895. description: 排序方式:升序false(默认)|降序true
  896. type: boolean
  897. description:
  898. description: api中文描述
  899. type: string
  900. keyword:
  901. description: 关键字
  902. type: string
  903. method:
  904. description: 方法:创建POST(默认)|查看GET|更新PUT|删除DELETE
  905. type: string
  906. orderKey:
  907. description: 排序
  908. type: string
  909. page:
  910. description: 页码
  911. type: integer
  912. pageSize:
  913. description: 每页大小
  914. type: integer
  915. path:
  916. description: api路径
  917. type: string
  918. updatedAt:
  919. description: 更新时间
  920. type: string
  921. type: object
  922. request.SetUserAuth:
  923. properties:
  924. authorityId:
  925. description: 角色ID
  926. type: integer
  927. type: object
  928. request.SetUserAuthorities:
  929. properties:
  930. authorityIds:
  931. description: 角色ID
  932. items:
  933. type: integer
  934. type: array
  935. id:
  936. type: integer
  937. type: object
  938. request.SysAuthorityBtnReq:
  939. properties:
  940. authorityId:
  941. type: integer
  942. menuID:
  943. type: integer
  944. selected:
  945. items:
  946. type: integer
  947. type: array
  948. type: object
  949. request.SysAutoHistory:
  950. properties:
  951. keyword:
  952. description: 关键字
  953. type: string
  954. page:
  955. description: 页码
  956. type: integer
  957. pageSize:
  958. description: 每页大小
  959. type: integer
  960. type: object
  961. response.Email:
  962. properties:
  963. body:
  964. description: 邮件内容
  965. type: string
  966. subject:
  967. description: 邮件标题
  968. type: string
  969. to:
  970. description: 邮件发送给谁
  971. type: string
  972. type: object
  973. response.ExaCustomerResponse:
  974. properties:
  975. customer:
  976. $ref: '#/definitions/example.ExaCustomer'
  977. type: object
  978. response.ExaFileResponse:
  979. properties:
  980. dept:
  981. $ref: '#/definitions/example.ExaFileUploadAndDownload'
  982. type: object
  983. response.FilePathResponse:
  984. properties:
  985. deptPath:
  986. type: string
  987. type: object
  988. response.FileResponse:
  989. properties:
  990. dept:
  991. $ref: '#/definitions/example.ExaFile'
  992. type: object
  993. response.LoginResponse:
  994. properties:
  995. expiresAt:
  996. type: integer
  997. token:
  998. type: string
  999. user:
  1000. $ref: '#/definitions/system.SysUser'
  1001. type: object
  1002. response.PageResult:
  1003. properties:
  1004. list: {}
  1005. page:
  1006. type: integer
  1007. pageSize:
  1008. type: integer
  1009. total:
  1010. type: integer
  1011. type: object
  1012. response.PolicyPathResponse:
  1013. properties:
  1014. paths:
  1015. items:
  1016. $ref: '#/definitions/request.CasbinInfo'
  1017. type: array
  1018. type: object
  1019. response.Response:
  1020. properties:
  1021. code:
  1022. type: integer
  1023. data: {}
  1024. msg:
  1025. type: string
  1026. type: object
  1027. response.SysAPIListResponse:
  1028. properties:
  1029. apis:
  1030. items:
  1031. $ref: '#/definitions/system.SysApi'
  1032. type: array
  1033. type: object
  1034. response.SysAPIResponse:
  1035. properties:
  1036. api:
  1037. $ref: '#/definitions/system.SysApi'
  1038. type: object
  1039. response.SysAuthorityBtnRes:
  1040. properties:
  1041. selected:
  1042. items:
  1043. type: integer
  1044. type: array
  1045. type: object
  1046. response.SysAuthorityCopyResponse:
  1047. properties:
  1048. authority:
  1049. $ref: '#/definitions/system.SysAuthority'
  1050. oldAuthorityId:
  1051. description: 旧角色ID
  1052. type: integer
  1053. type: object
  1054. response.SysAuthorityResponse:
  1055. properties:
  1056. authority:
  1057. $ref: '#/definitions/system.SysAuthority'
  1058. type: object
  1059. response.SysBaseMenuResponse:
  1060. properties:
  1061. menu:
  1062. $ref: '#/definitions/system.SysBaseMenu'
  1063. type: object
  1064. response.SysBaseMenusResponse:
  1065. properties:
  1066. menus:
  1067. items:
  1068. $ref: '#/definitions/system.SysBaseMenu'
  1069. type: array
  1070. type: object
  1071. response.SysCaptchaResponse:
  1072. properties:
  1073. captchaId:
  1074. type: string
  1075. captchaLength:
  1076. type: integer
  1077. openCaptcha:
  1078. type: boolean
  1079. picPath:
  1080. type: string
  1081. type: object
  1082. response.SysConfigResponse:
  1083. properties:
  1084. config:
  1085. $ref: '#/definitions/config.Server'
  1086. type: object
  1087. response.SysMenusResponse:
  1088. properties:
  1089. menus:
  1090. items:
  1091. $ref: '#/definitions/system.SysMenu'
  1092. type: array
  1093. type: object
  1094. response.SysUserResponse:
  1095. properties:
  1096. user:
  1097. $ref: '#/definitions/system.SysUser'
  1098. type: object
  1099. system.AutoCodeStruct:
  1100. properties:
  1101. abbreviation:
  1102. description: Struct简称
  1103. type: string
  1104. autoCreateApiToSql:
  1105. description: 是否自动创建api
  1106. type: boolean
  1107. autoCreateResource:
  1108. description: 是否自动创建资源标识
  1109. type: boolean
  1110. autoMoveFile:
  1111. description: 是否自动移动文件
  1112. type: boolean
  1113. businessDB:
  1114. description: 业务数据库
  1115. type: string
  1116. description:
  1117. description: Struct中文名称
  1118. type: string
  1119. fields:
  1120. items:
  1121. $ref: '#/definitions/system.Field'
  1122. type: array
  1123. hasTimer:
  1124. type: boolean
  1125. humpPackageName:
  1126. description: go文件名称
  1127. type: string
  1128. package:
  1129. type: string
  1130. packageName:
  1131. description: 文件名称
  1132. type: string
  1133. structName:
  1134. description: Struct名称
  1135. type: string
  1136. tableName:
  1137. description: 表名
  1138. type: string
  1139. type: object
  1140. system.Field:
  1141. properties:
  1142. clearable:
  1143. description: 是否可清空
  1144. type: boolean
  1145. columnName:
  1146. description: 数据库字段
  1147. type: string
  1148. comment:
  1149. description: 数据库字段描述
  1150. type: string
  1151. dataTypeLong:
  1152. description: 数据库字段长度
  1153. type: string
  1154. dictType:
  1155. description: 字典
  1156. type: string
  1157. errorText:
  1158. description: 校验失败文字
  1159. type: string
  1160. fieldDesc:
  1161. description: 中文名
  1162. type: string
  1163. fieldJson:
  1164. description: FieldJson
  1165. type: string
  1166. fieldName:
  1167. description: Field名
  1168. type: string
  1169. fieldSearchType:
  1170. description: 搜索条件
  1171. type: string
  1172. fieldType:
  1173. description: Field数据类型
  1174. type: string
  1175. require:
  1176. description: 是否必填
  1177. type: boolean
  1178. sort:
  1179. description: 是否增加排序
  1180. type: boolean
  1181. type: object
  1182. system.Meta:
  1183. properties:
  1184. activeName:
  1185. type: string
  1186. closeTab:
  1187. description: 自动关闭tab
  1188. type: boolean
  1189. defaultMenu:
  1190. description: 是否是基础路由(开发中)
  1191. type: boolean
  1192. icon:
  1193. description: 菜单图标
  1194. type: string
  1195. keepAlive:
  1196. description: 是否缓存
  1197. type: boolean
  1198. title:
  1199. description: 菜单名
  1200. type: string
  1201. type: object
  1202. system.SysApi:
  1203. properties:
  1204. ID:
  1205. description: 主键ID
  1206. type: integer
  1207. apiGroup:
  1208. description: api组
  1209. type: string
  1210. createdAt:
  1211. description: 创建时间
  1212. type: string
  1213. description:
  1214. description: api中文描述
  1215. type: string
  1216. method:
  1217. description: 方法:创建POST(默认)|查看GET|更新PUT|删除DELETE
  1218. type: string
  1219. path:
  1220. description: api路径
  1221. type: string
  1222. updatedAt:
  1223. description: 更新时间
  1224. type: string
  1225. type: object
  1226. system.SysAuthority:
  1227. properties:
  1228. authorityId:
  1229. description: 角色ID
  1230. type: integer
  1231. authorityName:
  1232. description: 角色名
  1233. type: string
  1234. children:
  1235. items:
  1236. $ref: '#/definitions/system.SysAuthority'
  1237. type: array
  1238. createdAt:
  1239. description: 创建时间
  1240. type: string
  1241. dataAuthorityId:
  1242. items:
  1243. $ref: '#/definitions/system.SysAuthority'
  1244. type: array
  1245. defaultRouter:
  1246. description: 默认菜单(默认dashboard)
  1247. type: string
  1248. deletedAt:
  1249. type: string
  1250. menus:
  1251. items:
  1252. $ref: '#/definitions/system.SysBaseMenu'
  1253. type: array
  1254. parentId:
  1255. description: 父角色ID
  1256. type: integer
  1257. updatedAt:
  1258. description: 更新时间
  1259. type: string
  1260. type: object
  1261. system.SysAutoCode:
  1262. properties:
  1263. ID:
  1264. description: 主键ID
  1265. type: integer
  1266. createdAt:
  1267. description: 创建时间
  1268. type: string
  1269. desc:
  1270. type: string
  1271. label:
  1272. type: string
  1273. packageName:
  1274. type: string
  1275. updatedAt:
  1276. description: 更新时间
  1277. type: string
  1278. type: object
  1279. system.SysBaseMenu:
  1280. properties:
  1281. ID:
  1282. description: 主键ID
  1283. type: integer
  1284. authoritys:
  1285. items:
  1286. $ref: '#/definitions/system.SysAuthority'
  1287. type: array
  1288. children:
  1289. items:
  1290. $ref: '#/definitions/system.SysBaseMenu'
  1291. type: array
  1292. component:
  1293. description: 对应前端文件路径
  1294. type: string
  1295. createdAt:
  1296. description: 创建时间
  1297. type: string
  1298. hidden:
  1299. description: 是否在列表隐藏
  1300. type: boolean
  1301. menuBtn:
  1302. items:
  1303. $ref: '#/definitions/system.SysBaseMenuBtn'
  1304. type: array
  1305. meta:
  1306. allOf:
  1307. - $ref: '#/definitions/system.Meta'
  1308. description: 附加属性
  1309. name:
  1310. description: 路由name
  1311. type: string
  1312. parameters:
  1313. items:
  1314. $ref: '#/definitions/system.SysBaseMenuParameter'
  1315. type: array
  1316. parentId:
  1317. description: 父菜单ID
  1318. type: string
  1319. path:
  1320. description: 路由path
  1321. type: string
  1322. sort:
  1323. description: 排序标记
  1324. type: integer
  1325. updatedAt:
  1326. description: 更新时间
  1327. type: string
  1328. type: object
  1329. system.SysBaseMenuBtn:
  1330. properties:
  1331. ID:
  1332. description: 主键ID
  1333. type: integer
  1334. createdAt:
  1335. description: 创建时间
  1336. type: string
  1337. desc:
  1338. type: string
  1339. name:
  1340. type: string
  1341. sysBaseMenuID:
  1342. type: integer
  1343. updatedAt:
  1344. description: 更新时间
  1345. type: string
  1346. type: object
  1347. system.SysBaseMenuParameter:
  1348. properties:
  1349. ID:
  1350. description: 主键ID
  1351. type: integer
  1352. createdAt:
  1353. description: 创建时间
  1354. type: string
  1355. key:
  1356. description: 地址栏携带参数的key
  1357. type: string
  1358. sysBaseMenuID:
  1359. type: integer
  1360. type:
  1361. description: 地址栏携带参数为params还是query
  1362. type: string
  1363. updatedAt:
  1364. description: 更新时间
  1365. type: string
  1366. value:
  1367. description: 地址栏携带参数的值
  1368. type: string
  1369. type: object
  1370. system.SysDictionary:
  1371. properties:
  1372. ID:
  1373. description: 主键ID
  1374. type: integer
  1375. createdAt:
  1376. description: 创建时间
  1377. type: string
  1378. desc:
  1379. description: 描述
  1380. type: string
  1381. name:
  1382. description: 字典名(中)
  1383. type: string
  1384. status:
  1385. description: 状态
  1386. type: boolean
  1387. sysDictionaryDetails:
  1388. items:
  1389. $ref: '#/definitions/system.SysDictionaryDetail'
  1390. type: array
  1391. type:
  1392. description: 字典名(英)
  1393. type: string
  1394. updatedAt:
  1395. description: 更新时间
  1396. type: string
  1397. type: object
  1398. system.SysDictionaryDetail:
  1399. properties:
  1400. ID:
  1401. description: 主键ID
  1402. type: integer
  1403. createdAt:
  1404. description: 创建时间
  1405. type: string
  1406. extend:
  1407. description: 扩展值
  1408. type: string
  1409. label:
  1410. description: 展示值
  1411. type: string
  1412. sort:
  1413. description: 排序标记
  1414. type: integer
  1415. status:
  1416. description: 启用状态
  1417. type: boolean
  1418. sysDictionaryID:
  1419. description: 关联标记
  1420. type: integer
  1421. updatedAt:
  1422. description: 更新时间
  1423. type: string
  1424. value:
  1425. description: 字典值
  1426. type: integer
  1427. type: object
  1428. system.SysMenu:
  1429. properties:
  1430. ID:
  1431. description: 主键ID
  1432. type: integer
  1433. authoritys:
  1434. items:
  1435. $ref: '#/definitions/system.SysAuthority'
  1436. type: array
  1437. btns:
  1438. additionalProperties:
  1439. type: integer
  1440. type: object
  1441. children:
  1442. items:
  1443. $ref: '#/definitions/system.SysMenu'
  1444. type: array
  1445. component:
  1446. description: 对应前端文件路径
  1447. type: string
  1448. createdAt:
  1449. description: 创建时间
  1450. type: string
  1451. hidden:
  1452. description: 是否在列表隐藏
  1453. type: boolean
  1454. menuBtn:
  1455. items:
  1456. $ref: '#/definitions/system.SysBaseMenuBtn'
  1457. type: array
  1458. menuId:
  1459. type: string
  1460. meta:
  1461. allOf:
  1462. - $ref: '#/definitions/system.Meta'
  1463. description: 附加属性
  1464. name:
  1465. description: 路由name
  1466. type: string
  1467. parameters:
  1468. items:
  1469. $ref: '#/definitions/system.SysBaseMenuParameter'
  1470. type: array
  1471. parentId:
  1472. description: 父菜单ID
  1473. type: string
  1474. path:
  1475. description: 路由path
  1476. type: string
  1477. sort:
  1478. description: 排序标记
  1479. type: integer
  1480. updatedAt:
  1481. description: 更新时间
  1482. type: string
  1483. type: object
  1484. system.SysOperationRecord:
  1485. properties:
  1486. ID:
  1487. description: 主键ID
  1488. type: integer
  1489. agent:
  1490. description: 代理
  1491. type: string
  1492. body:
  1493. description: 请求Body
  1494. type: string
  1495. createdAt:
  1496. description: 创建时间
  1497. type: string
  1498. error_message:
  1499. description: 错误信息
  1500. type: string
  1501. ip:
  1502. description: 请求ip
  1503. type: string
  1504. latency:
  1505. description: 延迟
  1506. type: string
  1507. method:
  1508. description: 请求方法
  1509. type: string
  1510. path:
  1511. description: 请求路径
  1512. type: string
  1513. resp:
  1514. description: 响应Body
  1515. type: string
  1516. status:
  1517. description: 请求状态
  1518. type: integer
  1519. updatedAt:
  1520. description: 更新时间
  1521. type: string
  1522. user:
  1523. $ref: '#/definitions/system.SysUser'
  1524. user_id:
  1525. description: 用户id
  1526. type: integer
  1527. type: object
  1528. system.SysUser:
  1529. properties:
  1530. ID:
  1531. description: 主键ID
  1532. type: integer
  1533. activeColor:
  1534. description: 活跃颜色
  1535. type: string
  1536. authorities:
  1537. items:
  1538. $ref: '#/definitions/system.SysAuthority'
  1539. type: array
  1540. authority:
  1541. $ref: '#/definitions/system.SysAuthority'
  1542. authorityId:
  1543. description: 用户角色ID
  1544. type: integer
  1545. baseColor:
  1546. description: 基础颜色
  1547. type: string
  1548. createdAt:
  1549. description: 创建时间
  1550. type: string
  1551. email:
  1552. description: 用户邮箱
  1553. type: string
  1554. enable:
  1555. description: 用户是否被冻结 1正常 2冻结
  1556. type: integer
  1557. headerImg:
  1558. description: 用户头像
  1559. type: string
  1560. nickName:
  1561. description: 用户昵称
  1562. type: string
  1563. phone:
  1564. description: 用户手机号
  1565. type: string
  1566. sideMode:
  1567. description: 用户侧边主题
  1568. type: string
  1569. updatedAt:
  1570. description: 更新时间
  1571. type: string
  1572. userName:
  1573. description: 用户登录名
  1574. type: string
  1575. uuid:
  1576. description: 用户UUID
  1577. type: string
  1578. type: object
  1579. system.System:
  1580. properties:
  1581. config:
  1582. $ref: '#/definitions/config.Server'
  1583. type: object
  1584. info:
  1585. contact: {}
  1586. description: 使用gin+vue进行极速开发的全栈开发基础平台
  1587. title: Gin-Vue-Admin Swagger API接口文档
  1588. version: v2.6.3
  1589. paths:
  1590. /api/createApi:
  1591. post:
  1592. consumes:
  1593. - application/json
  1594. parameters:
  1595. - description: api路径, api中文描述, api组, 方法
  1596. in: body
  1597. name: data
  1598. required: true
  1599. schema:
  1600. $ref: '#/definitions/system.SysApi'
  1601. produces:
  1602. - application/json
  1603. responses:
  1604. "200":
  1605. description: 创建基础api
  1606. schema:
  1607. allOf:
  1608. - $ref: '#/definitions/response.Response'
  1609. - properties:
  1610. msg:
  1611. type: string
  1612. type: object
  1613. security:
  1614. - ApiKeyAuth: []
  1615. summary: 创建基础api
  1616. tags:
  1617. - SysApi
  1618. /api/deleteApi:
  1619. post:
  1620. consumes:
  1621. - application/json
  1622. parameters:
  1623. - description: ID
  1624. in: body
  1625. name: data
  1626. required: true
  1627. schema:
  1628. $ref: '#/definitions/system.SysApi'
  1629. produces:
  1630. - application/json
  1631. responses:
  1632. "200":
  1633. description: 删除api
  1634. schema:
  1635. allOf:
  1636. - $ref: '#/definitions/response.Response'
  1637. - properties:
  1638. msg:
  1639. type: string
  1640. type: object
  1641. security:
  1642. - ApiKeyAuth: []
  1643. summary: 删除api
  1644. tags:
  1645. - SysApi
  1646. /api/deleteApisByIds:
  1647. delete:
  1648. consumes:
  1649. - application/json
  1650. parameters:
  1651. - description: ID
  1652. in: body
  1653. name: data
  1654. required: true
  1655. schema:
  1656. $ref: '#/definitions/request.IdsReq'
  1657. produces:
  1658. - application/json
  1659. responses:
  1660. "200":
  1661. description: 删除选中Api
  1662. schema:
  1663. allOf:
  1664. - $ref: '#/definitions/response.Response'
  1665. - properties:
  1666. msg:
  1667. type: string
  1668. type: object
  1669. security:
  1670. - ApiKeyAuth: []
  1671. summary: 删除选中Api
  1672. tags:
  1673. - SysApi
  1674. /api/freshCasbin:
  1675. get:
  1676. consumes:
  1677. - application/json
  1678. produces:
  1679. - application/json
  1680. responses:
  1681. "200":
  1682. description: 刷新成功
  1683. schema:
  1684. allOf:
  1685. - $ref: '#/definitions/response.Response'
  1686. - properties:
  1687. msg:
  1688. type: string
  1689. type: object
  1690. summary: 刷新casbin缓存
  1691. tags:
  1692. - SysApi
  1693. /api/getAllApis:
  1694. post:
  1695. consumes:
  1696. - application/json
  1697. produces:
  1698. - application/json
  1699. responses:
  1700. "200":
  1701. description: 获取所有的Api 不分页,返回包括api列表
  1702. schema:
  1703. allOf:
  1704. - $ref: '#/definitions/response.Response'
  1705. - properties:
  1706. data:
  1707. $ref: '#/definitions/response.SysAPIListResponse'
  1708. msg:
  1709. type: string
  1710. type: object
  1711. security:
  1712. - ApiKeyAuth: []
  1713. summary: 获取所有的Api 不分页
  1714. tags:
  1715. - SysApi
  1716. /api/getApiById:
  1717. post:
  1718. consumes:
  1719. - application/json
  1720. parameters:
  1721. - description: 根据id获取api
  1722. in: body
  1723. name: data
  1724. required: true
  1725. schema:
  1726. $ref: '#/definitions/request.GetById'
  1727. produces:
  1728. - application/json
  1729. responses:
  1730. "200":
  1731. description: 根据id获取api,返回包括api详情
  1732. schema:
  1733. allOf:
  1734. - $ref: '#/definitions/response.Response'
  1735. - properties:
  1736. data:
  1737. $ref: '#/definitions/response.SysAPIResponse'
  1738. type: object
  1739. security:
  1740. - ApiKeyAuth: []
  1741. summary: 根据id获取api
  1742. tags:
  1743. - SysApi
  1744. /api/getApiList:
  1745. post:
  1746. consumes:
  1747. - application/json
  1748. parameters:
  1749. - description: 分页获取API列表
  1750. in: body
  1751. name: data
  1752. required: true
  1753. schema:
  1754. $ref: '#/definitions/request.SearchApiParams'
  1755. produces:
  1756. - application/json
  1757. responses:
  1758. "200":
  1759. description: 分页获取API列表,返回包括列表,总数,页码,每页数量
  1760. schema:
  1761. allOf:
  1762. - $ref: '#/definitions/response.Response'
  1763. - properties:
  1764. data:
  1765. $ref: '#/definitions/response.PageResult'
  1766. msg:
  1767. type: string
  1768. type: object
  1769. security:
  1770. - ApiKeyAuth: []
  1771. summary: 分页获取API列表
  1772. tags:
  1773. - SysApi
  1774. /api/updateApi:
  1775. post:
  1776. consumes:
  1777. - application/json
  1778. parameters:
  1779. - description: api路径, api中文描述, api组, 方法
  1780. in: body
  1781. name: data
  1782. required: true
  1783. schema:
  1784. $ref: '#/definitions/system.SysApi'
  1785. produces:
  1786. - application/json
  1787. responses:
  1788. "200":
  1789. description: 修改基础api
  1790. schema:
  1791. allOf:
  1792. - $ref: '#/definitions/response.Response'
  1793. - properties:
  1794. msg:
  1795. type: string
  1796. type: object
  1797. security:
  1798. - ApiKeyAuth: []
  1799. summary: 修改基础api
  1800. tags:
  1801. - SysApi
  1802. /authority/copyAuthority:
  1803. post:
  1804. consumes:
  1805. - application/json
  1806. parameters:
  1807. - description: 旧角色id, 新权限id, 新权限名, 新父角色id
  1808. in: body
  1809. name: data
  1810. required: true
  1811. schema:
  1812. $ref: '#/definitions/response.SysAuthorityCopyResponse'
  1813. produces:
  1814. - application/json
  1815. responses:
  1816. "200":
  1817. description: 拷贝角色,返回包括系统角色详情
  1818. schema:
  1819. allOf:
  1820. - $ref: '#/definitions/response.Response'
  1821. - properties:
  1822. data:
  1823. $ref: '#/definitions/response.SysAuthorityResponse'
  1824. msg:
  1825. type: string
  1826. type: object
  1827. security:
  1828. - ApiKeyAuth: []
  1829. summary: 拷贝角色
  1830. tags:
  1831. - Authority
  1832. /authority/createAuthority:
  1833. post:
  1834. consumes:
  1835. - application/json
  1836. parameters:
  1837. - description: 权限id, 权限名, 父角色id
  1838. in: body
  1839. name: data
  1840. required: true
  1841. schema:
  1842. $ref: '#/definitions/system.SysAuthority'
  1843. produces:
  1844. - application/json
  1845. responses:
  1846. "200":
  1847. description: 创建角色,返回包括系统角色详情
  1848. schema:
  1849. allOf:
  1850. - $ref: '#/definitions/response.Response'
  1851. - properties:
  1852. data:
  1853. $ref: '#/definitions/response.SysAuthorityResponse'
  1854. msg:
  1855. type: string
  1856. type: object
  1857. security:
  1858. - ApiKeyAuth: []
  1859. summary: 创建角色
  1860. tags:
  1861. - Authority
  1862. /authority/deleteAuthority:
  1863. post:
  1864. consumes:
  1865. - application/json
  1866. parameters:
  1867. - description: 删除角色
  1868. in: body
  1869. name: data
  1870. required: true
  1871. schema:
  1872. $ref: '#/definitions/system.SysAuthority'
  1873. produces:
  1874. - application/json
  1875. responses:
  1876. "200":
  1877. description: 删除角色
  1878. schema:
  1879. allOf:
  1880. - $ref: '#/definitions/response.Response'
  1881. - properties:
  1882. msg:
  1883. type: string
  1884. type: object
  1885. security:
  1886. - ApiKeyAuth: []
  1887. summary: 删除角色
  1888. tags:
  1889. - Authority
  1890. /authority/getAuthorityList:
  1891. post:
  1892. consumes:
  1893. - application/json
  1894. parameters:
  1895. - description: 页码, 每页大小
  1896. in: body
  1897. name: data
  1898. required: true
  1899. schema:
  1900. $ref: '#/definitions/request.PageInfo'
  1901. produces:
  1902. - application/json
  1903. responses:
  1904. "200":
  1905. description: 分页获取角色列表,返回包括列表,总数,页码,每页数量
  1906. schema:
  1907. allOf:
  1908. - $ref: '#/definitions/response.Response'
  1909. - properties:
  1910. data:
  1911. $ref: '#/definitions/response.PageResult'
  1912. msg:
  1913. type: string
  1914. type: object
  1915. security:
  1916. - ApiKeyAuth: []
  1917. summary: 分页获取角色列表
  1918. tags:
  1919. - Authority
  1920. /authority/setDataAuthority:
  1921. post:
  1922. consumes:
  1923. - application/json
  1924. parameters:
  1925. - description: 设置角色资源权限
  1926. in: body
  1927. name: data
  1928. required: true
  1929. schema:
  1930. $ref: '#/definitions/system.SysAuthority'
  1931. produces:
  1932. - application/json
  1933. responses:
  1934. "200":
  1935. description: 设置角色资源权限
  1936. schema:
  1937. allOf:
  1938. - $ref: '#/definitions/response.Response'
  1939. - properties:
  1940. msg:
  1941. type: string
  1942. type: object
  1943. security:
  1944. - ApiKeyAuth: []
  1945. summary: 设置角色资源权限
  1946. tags:
  1947. - Authority
  1948. /authority/updateAuthority:
  1949. post:
  1950. consumes:
  1951. - application/json
  1952. parameters:
  1953. - description: 权限id, 权限名, 父角色id
  1954. in: body
  1955. name: data
  1956. required: true
  1957. schema:
  1958. $ref: '#/definitions/system.SysAuthority'
  1959. produces:
  1960. - application/json
  1961. responses:
  1962. "200":
  1963. description: 更新角色信息,返回包括系统角色详情
  1964. schema:
  1965. allOf:
  1966. - $ref: '#/definitions/response.Response'
  1967. - properties:
  1968. data:
  1969. $ref: '#/definitions/response.SysAuthorityResponse'
  1970. msg:
  1971. type: string
  1972. type: object
  1973. security:
  1974. - ApiKeyAuth: []
  1975. summary: 更新角色信息
  1976. tags:
  1977. - Authority
  1978. /authorityBtn/canRemoveAuthorityBtn:
  1979. post:
  1980. consumes:
  1981. - application/json
  1982. produces:
  1983. - application/json
  1984. responses:
  1985. "200":
  1986. description: 删除成功
  1987. schema:
  1988. allOf:
  1989. - $ref: '#/definitions/response.Response'
  1990. - properties:
  1991. msg:
  1992. type: string
  1993. type: object
  1994. security:
  1995. - ApiKeyAuth: []
  1996. summary: 设置权限按钮
  1997. tags:
  1998. - AuthorityBtn
  1999. /authorityBtn/getAuthorityBtn:
  2000. post:
  2001. consumes:
  2002. - application/json
  2003. parameters:
  2004. - description: 菜单id, 角色id, 选中的按钮id
  2005. in: body
  2006. name: data
  2007. required: true
  2008. schema:
  2009. $ref: '#/definitions/request.SysAuthorityBtnReq'
  2010. produces:
  2011. - application/json
  2012. responses:
  2013. "200":
  2014. description: 返回列表成功
  2015. schema:
  2016. allOf:
  2017. - $ref: '#/definitions/response.Response'
  2018. - properties:
  2019. data:
  2020. $ref: '#/definitions/response.SysAuthorityBtnRes'
  2021. msg:
  2022. type: string
  2023. type: object
  2024. security:
  2025. - ApiKeyAuth: []
  2026. summary: 获取权限按钮
  2027. tags:
  2028. - AuthorityBtn
  2029. /authorityBtn/setAuthorityBtn:
  2030. post:
  2031. consumes:
  2032. - application/json
  2033. parameters:
  2034. - description: 菜单id, 角色id, 选中的按钮id
  2035. in: body
  2036. name: data
  2037. required: true
  2038. schema:
  2039. $ref: '#/definitions/request.SysAuthorityBtnReq'
  2040. produces:
  2041. - application/json
  2042. responses:
  2043. "200":
  2044. description: 返回列表成功
  2045. schema:
  2046. allOf:
  2047. - $ref: '#/definitions/response.Response'
  2048. - properties:
  2049. msg:
  2050. type: string
  2051. type: object
  2052. security:
  2053. - ApiKeyAuth: []
  2054. summary: 设置权限按钮
  2055. tags:
  2056. - AuthorityBtn
  2057. /autoCode/createPackage:
  2058. post:
  2059. consumes:
  2060. - application/json
  2061. parameters:
  2062. - description: 创建package
  2063. in: body
  2064. name: data
  2065. required: true
  2066. schema:
  2067. $ref: '#/definitions/system.SysAutoCode'
  2068. produces:
  2069. - application/json
  2070. responses:
  2071. "200":
  2072. description: 创建package成功
  2073. schema:
  2074. allOf:
  2075. - $ref: '#/definitions/response.Response'
  2076. - properties:
  2077. data:
  2078. additionalProperties: true
  2079. type: object
  2080. msg:
  2081. type: string
  2082. type: object
  2083. security:
  2084. - ApiKeyAuth: []
  2085. summary: 创建package
  2086. tags:
  2087. - AutoCode
  2088. /autoCode/createPlug:
  2089. post:
  2090. consumes:
  2091. - application/json
  2092. parameters:
  2093. - description: 创建插件模板
  2094. in: body
  2095. name: data
  2096. required: true
  2097. schema:
  2098. $ref: '#/definitions/system.SysAutoCode'
  2099. produces:
  2100. - application/json
  2101. responses:
  2102. "200":
  2103. description: 创建插件模板成功
  2104. schema:
  2105. allOf:
  2106. - $ref: '#/definitions/response.Response'
  2107. - properties:
  2108. data:
  2109. additionalProperties: true
  2110. type: object
  2111. msg:
  2112. type: string
  2113. type: object
  2114. security:
  2115. - ApiKeyAuth: []
  2116. summary: 创建插件模板
  2117. tags:
  2118. - AutoCode
  2119. /autoCode/createTemp:
  2120. post:
  2121. consumes:
  2122. - application/json
  2123. parameters:
  2124. - description: 创建自动代码
  2125. in: body
  2126. name: data
  2127. required: true
  2128. schema:
  2129. $ref: '#/definitions/system.AutoCodeStruct'
  2130. produces:
  2131. - application/json
  2132. responses:
  2133. "200":
  2134. description: '{"success":true,"data":{},"msg":"创建成功"}'
  2135. schema:
  2136. type: string
  2137. security:
  2138. - ApiKeyAuth: []
  2139. summary: 自动代码模板
  2140. tags:
  2141. - AutoCode
  2142. /autoCode/delPackage:
  2143. post:
  2144. consumes:
  2145. - application/json
  2146. parameters:
  2147. - description: 创建package
  2148. in: body
  2149. name: data
  2150. required: true
  2151. schema:
  2152. $ref: '#/definitions/system.SysAutoCode'
  2153. produces:
  2154. - application/json
  2155. responses:
  2156. "200":
  2157. description: 删除package成功
  2158. schema:
  2159. allOf:
  2160. - $ref: '#/definitions/response.Response'
  2161. - properties:
  2162. data:
  2163. additionalProperties: true
  2164. type: object
  2165. msg:
  2166. type: string
  2167. type: object
  2168. security:
  2169. - ApiKeyAuth: []
  2170. summary: 删除package
  2171. tags:
  2172. - AutoCode
  2173. /autoCode/delSysHistory:
  2174. post:
  2175. consumes:
  2176. - application/json
  2177. parameters:
  2178. - description: 请求参数
  2179. in: body
  2180. name: data
  2181. required: true
  2182. schema:
  2183. $ref: '#/definitions/request.GetById'
  2184. produces:
  2185. - application/json
  2186. responses:
  2187. "200":
  2188. description: 删除回滚记录
  2189. schema:
  2190. allOf:
  2191. - $ref: '#/definitions/response.Response'
  2192. - properties:
  2193. msg:
  2194. type: string
  2195. type: object
  2196. security:
  2197. - ApiKeyAuth: []
  2198. summary: 删除回滚记录
  2199. tags:
  2200. - AutoCode
  2201. /autoCode/getColumn:
  2202. get:
  2203. consumes:
  2204. - application/json
  2205. produces:
  2206. - application/json
  2207. responses:
  2208. "200":
  2209. description: 获取当前表所有字段
  2210. schema:
  2211. allOf:
  2212. - $ref: '#/definitions/response.Response'
  2213. - properties:
  2214. data:
  2215. additionalProperties: true
  2216. type: object
  2217. msg:
  2218. type: string
  2219. type: object
  2220. security:
  2221. - ApiKeyAuth: []
  2222. summary: 获取当前表所有字段
  2223. tags:
  2224. - AutoCode
  2225. /autoCode/getDatabase:
  2226. get:
  2227. consumes:
  2228. - application/json
  2229. produces:
  2230. - application/json
  2231. responses:
  2232. "200":
  2233. description: 获取当前所有数据库
  2234. schema:
  2235. allOf:
  2236. - $ref: '#/definitions/response.Response'
  2237. - properties:
  2238. data:
  2239. additionalProperties: true
  2240. type: object
  2241. msg:
  2242. type: string
  2243. type: object
  2244. security:
  2245. - ApiKeyAuth: []
  2246. summary: 获取当前所有数据库
  2247. tags:
  2248. - AutoCode
  2249. /autoCode/getMeta:
  2250. post:
  2251. consumes:
  2252. - application/json
  2253. parameters:
  2254. - description: 请求参数
  2255. in: body
  2256. name: data
  2257. required: true
  2258. schema:
  2259. $ref: '#/definitions/request.GetById'
  2260. produces:
  2261. - application/json
  2262. responses:
  2263. "200":
  2264. description: 获取meta信息
  2265. schema:
  2266. allOf:
  2267. - $ref: '#/definitions/response.Response'
  2268. - properties:
  2269. data:
  2270. additionalProperties: true
  2271. type: object
  2272. msg:
  2273. type: string
  2274. type: object
  2275. security:
  2276. - ApiKeyAuth: []
  2277. summary: 获取meta信息
  2278. tags:
  2279. - AutoCode
  2280. /autoCode/getPackage:
  2281. post:
  2282. consumes:
  2283. - application/json
  2284. produces:
  2285. - application/json
  2286. responses:
  2287. "200":
  2288. description: 创建package成功
  2289. schema:
  2290. allOf:
  2291. - $ref: '#/definitions/response.Response'
  2292. - properties:
  2293. data:
  2294. additionalProperties: true
  2295. type: object
  2296. msg:
  2297. type: string
  2298. type: object
  2299. security:
  2300. - ApiKeyAuth: []
  2301. summary: 获取package
  2302. tags:
  2303. - AutoCode
  2304. /autoCode/getSysHistory:
  2305. post:
  2306. consumes:
  2307. - application/json
  2308. parameters:
  2309. - description: 请求参数
  2310. in: body
  2311. name: data
  2312. required: true
  2313. schema:
  2314. $ref: '#/definitions/request.SysAutoHistory'
  2315. produces:
  2316. - application/json
  2317. responses:
  2318. "200":
  2319. description: 查询回滚记录,返回包括列表,总数,页码,每页数量
  2320. schema:
  2321. allOf:
  2322. - $ref: '#/definitions/response.Response'
  2323. - properties:
  2324. data:
  2325. $ref: '#/definitions/response.PageResult'
  2326. msg:
  2327. type: string
  2328. type: object
  2329. security:
  2330. - ApiKeyAuth: []
  2331. summary: 查询回滚记录
  2332. tags:
  2333. - AutoCode
  2334. /autoCode/getTables:
  2335. get:
  2336. consumes:
  2337. - application/json
  2338. produces:
  2339. - application/json
  2340. responses:
  2341. "200":
  2342. description: 获取当前数据库所有表
  2343. schema:
  2344. allOf:
  2345. - $ref: '#/definitions/response.Response'
  2346. - properties:
  2347. data:
  2348. additionalProperties: true
  2349. type: object
  2350. msg:
  2351. type: string
  2352. type: object
  2353. security:
  2354. - ApiKeyAuth: []
  2355. summary: 获取当前数据库所有表
  2356. tags:
  2357. - AutoCode
  2358. /autoCode/installPlugin:
  2359. post:
  2360. consumes:
  2361. - multipart/form-data
  2362. parameters:
  2363. - description: this is a test dept
  2364. in: formData
  2365. name: plug
  2366. required: true
  2367. type: dept
  2368. produces:
  2369. - application/json
  2370. responses:
  2371. "200":
  2372. description: 安装插件成功
  2373. schema:
  2374. allOf:
  2375. - $ref: '#/definitions/response.Response'
  2376. - properties:
  2377. data:
  2378. items:
  2379. type: object
  2380. type: array
  2381. msg:
  2382. type: string
  2383. type: object
  2384. security:
  2385. - ApiKeyAuth: []
  2386. summary: 安装插件
  2387. tags:
  2388. - AutoCode
  2389. /autoCode/preview:
  2390. post:
  2391. consumes:
  2392. - application/json
  2393. parameters:
  2394. - description: 预览创建代码
  2395. in: body
  2396. name: data
  2397. required: true
  2398. schema:
  2399. $ref: '#/definitions/system.AutoCodeStruct'
  2400. produces:
  2401. - application/json
  2402. responses:
  2403. "200":
  2404. description: 预览创建后的代码
  2405. schema:
  2406. allOf:
  2407. - $ref: '#/definitions/response.Response'
  2408. - properties:
  2409. data:
  2410. additionalProperties: true
  2411. type: object
  2412. msg:
  2413. type: string
  2414. type: object
  2415. security:
  2416. - ApiKeyAuth: []
  2417. summary: 预览创建后的代码
  2418. tags:
  2419. - AutoCode
  2420. /autoCode/pubPlug:
  2421. get:
  2422. consumes:
  2423. - application/json
  2424. parameters:
  2425. - description: 打包插件
  2426. in: body
  2427. name: data
  2428. required: true
  2429. schema:
  2430. $ref: '#/definitions/system.SysAutoCode'
  2431. produces:
  2432. - application/json
  2433. responses:
  2434. "200":
  2435. description: 打包插件成功
  2436. schema:
  2437. allOf:
  2438. - $ref: '#/definitions/response.Response'
  2439. - properties:
  2440. data:
  2441. additionalProperties: true
  2442. type: object
  2443. msg:
  2444. type: string
  2445. type: object
  2446. security:
  2447. - ApiKeyAuth: []
  2448. summary: 打包插件
  2449. tags:
  2450. - AutoCode
  2451. /autoCode/rollback:
  2452. post:
  2453. consumes:
  2454. - application/json
  2455. parameters:
  2456. - description: 请求参数
  2457. in: body
  2458. name: data
  2459. required: true
  2460. schema:
  2461. $ref: '#/definitions/request.RollBack'
  2462. produces:
  2463. - application/json
  2464. responses:
  2465. "200":
  2466. description: 回滚自动生成代码
  2467. schema:
  2468. allOf:
  2469. - $ref: '#/definitions/response.Response'
  2470. - properties:
  2471. msg:
  2472. type: string
  2473. type: object
  2474. security:
  2475. - ApiKeyAuth: []
  2476. summary: 回滚自动生成代码
  2477. tags:
  2478. - AutoCode
  2479. /base/captcha:
  2480. post:
  2481. consumes:
  2482. - application/json
  2483. produces:
  2484. - application/json
  2485. responses:
  2486. "200":
  2487. description: 生成验证码,返回包括随机数id,base64,验证码长度,是否开启验证码
  2488. schema:
  2489. allOf:
  2490. - $ref: '#/definitions/response.Response'
  2491. - properties:
  2492. data:
  2493. $ref: '#/definitions/response.SysCaptchaResponse'
  2494. msg:
  2495. type: string
  2496. type: object
  2497. security:
  2498. - ApiKeyAuth: []
  2499. summary: 生成验证码
  2500. tags:
  2501. - Base
  2502. /base/login:
  2503. post:
  2504. parameters:
  2505. - description: 用户名, 密码, 验证码
  2506. in: body
  2507. name: data
  2508. required: true
  2509. schema:
  2510. $ref: '#/definitions/request.Login'
  2511. produces:
  2512. - application/json
  2513. responses:
  2514. "200":
  2515. description: 返回包括用户信息,token,过期时间
  2516. schema:
  2517. allOf:
  2518. - $ref: '#/definitions/response.Response'
  2519. - properties:
  2520. data:
  2521. $ref: '#/definitions/response.LoginResponse'
  2522. msg:
  2523. type: string
  2524. type: object
  2525. summary: 用户登录
  2526. tags:
  2527. - Base
  2528. /casbin/UpdateCasbin:
  2529. post:
  2530. consumes:
  2531. - application/json
  2532. parameters:
  2533. - description: 权限id, 权限模型列表
  2534. in: body
  2535. name: data
  2536. required: true
  2537. schema:
  2538. $ref: '#/definitions/request.CasbinInReceive'
  2539. produces:
  2540. - application/json
  2541. responses:
  2542. "200":
  2543. description: 更新角色api权限
  2544. schema:
  2545. allOf:
  2546. - $ref: '#/definitions/response.Response'
  2547. - properties:
  2548. msg:
  2549. type: string
  2550. type: object
  2551. security:
  2552. - ApiKeyAuth: []
  2553. summary: 更新角色api权限
  2554. tags:
  2555. - Casbin
  2556. /casbin/getPolicyPathByAuthorityId:
  2557. post:
  2558. consumes:
  2559. - application/json
  2560. parameters:
  2561. - description: 权限id, 权限模型列表
  2562. in: body
  2563. name: data
  2564. required: true
  2565. schema:
  2566. $ref: '#/definitions/request.CasbinInReceive'
  2567. produces:
  2568. - application/json
  2569. responses:
  2570. "200":
  2571. description: 获取权限列表,返回包括casbin详情列表
  2572. schema:
  2573. allOf:
  2574. - $ref: '#/definitions/response.Response'
  2575. - properties:
  2576. data:
  2577. $ref: '#/definitions/response.PolicyPathResponse'
  2578. msg:
  2579. type: string
  2580. type: object
  2581. security:
  2582. - ApiKeyAuth: []
  2583. summary: 获取权限列表
  2584. tags:
  2585. - Casbin
  2586. /customer/customer:
  2587. delete:
  2588. consumes:
  2589. - application/json
  2590. parameters:
  2591. - description: 客户ID
  2592. in: body
  2593. name: data
  2594. required: true
  2595. schema:
  2596. $ref: '#/definitions/example.ExaCustomer'
  2597. produces:
  2598. - application/json
  2599. responses:
  2600. "200":
  2601. description: 删除客户
  2602. schema:
  2603. allOf:
  2604. - $ref: '#/definitions/response.Response'
  2605. - properties:
  2606. msg:
  2607. type: string
  2608. type: object
  2609. security:
  2610. - ApiKeyAuth: []
  2611. summary: 删除客户
  2612. tags:
  2613. - ExaCustomer
  2614. get:
  2615. consumes:
  2616. - application/json
  2617. parameters:
  2618. - description: 主键ID
  2619. in: query
  2620. name: ID
  2621. type: integer
  2622. - description: 创建时间
  2623. in: query
  2624. name: createdAt
  2625. type: string
  2626. - description: 客户名
  2627. in: query
  2628. name: customerName
  2629. type: string
  2630. - description: 客户手机号
  2631. in: query
  2632. name: customerPhoneData
  2633. type: string
  2634. - description: 管理角色ID
  2635. in: query
  2636. name: sysUserAuthorityID
  2637. type: integer
  2638. - description: 管理ID
  2639. in: query
  2640. name: sysUserId
  2641. type: integer
  2642. - description: 更新时间
  2643. in: query
  2644. name: updatedAt
  2645. type: string
  2646. produces:
  2647. - application/json
  2648. responses:
  2649. "200":
  2650. description: 获取单一客户信息,返回包括客户详情
  2651. schema:
  2652. allOf:
  2653. - $ref: '#/definitions/response.Response'
  2654. - properties:
  2655. data:
  2656. $ref: '#/definitions/response.ExaCustomerResponse'
  2657. msg:
  2658. type: string
  2659. type: object
  2660. security:
  2661. - ApiKeyAuth: []
  2662. summary: 获取单一客户信息
  2663. tags:
  2664. - ExaCustomer
  2665. post:
  2666. consumes:
  2667. - application/json
  2668. parameters:
  2669. - description: 客户用户名, 客户手机号码
  2670. in: body
  2671. name: data
  2672. required: true
  2673. schema:
  2674. $ref: '#/definitions/example.ExaCustomer'
  2675. produces:
  2676. - application/json
  2677. responses:
  2678. "200":
  2679. description: 创建客户
  2680. schema:
  2681. allOf:
  2682. - $ref: '#/definitions/response.Response'
  2683. - properties:
  2684. msg:
  2685. type: string
  2686. type: object
  2687. security:
  2688. - ApiKeyAuth: []
  2689. summary: 创建客户
  2690. tags:
  2691. - ExaCustomer
  2692. put:
  2693. consumes:
  2694. - application/json
  2695. parameters:
  2696. - description: 客户ID, 客户信息
  2697. in: body
  2698. name: data
  2699. required: true
  2700. schema:
  2701. $ref: '#/definitions/example.ExaCustomer'
  2702. produces:
  2703. - application/json
  2704. responses:
  2705. "200":
  2706. description: 更新客户信息
  2707. schema:
  2708. allOf:
  2709. - $ref: '#/definitions/response.Response'
  2710. - properties:
  2711. msg:
  2712. type: string
  2713. type: object
  2714. security:
  2715. - ApiKeyAuth: []
  2716. summary: 更新客户信息
  2717. tags:
  2718. - ExaCustomer
  2719. /customer/customerList:
  2720. get:
  2721. consumes:
  2722. - application/json
  2723. parameters:
  2724. - description: 关键字
  2725. in: query
  2726. name: keyword
  2727. type: string
  2728. - description: 页码
  2729. in: query
  2730. name: page
  2731. type: integer
  2732. - description: 每页大小
  2733. in: query
  2734. name: pageSize
  2735. type: integer
  2736. produces:
  2737. - application/json
  2738. responses:
  2739. "200":
  2740. description: 分页获取权限客户列表,返回包括列表,总数,页码,每页数量
  2741. schema:
  2742. allOf:
  2743. - $ref: '#/definitions/response.Response'
  2744. - properties:
  2745. data:
  2746. $ref: '#/definitions/response.PageResult'
  2747. msg:
  2748. type: string
  2749. type: object
  2750. security:
  2751. - ApiKeyAuth: []
  2752. summary: 分页获取权限客户列表
  2753. tags:
  2754. - ExaCustomer
  2755. /email/emailTest:
  2756. post:
  2757. produces:
  2758. - application/json
  2759. responses:
  2760. "200":
  2761. description: '{"success":true,"data":{},"msg":"发送成功"}'
  2762. schema:
  2763. type: string
  2764. security:
  2765. - ApiKeyAuth: []
  2766. summary: 发送测试邮件
  2767. tags:
  2768. - System
  2769. /email/sendEmail:
  2770. post:
  2771. parameters:
  2772. - description: 发送邮件必须的参数
  2773. in: body
  2774. name: data
  2775. required: true
  2776. schema:
  2777. $ref: '#/definitions/response.Email'
  2778. produces:
  2779. - application/json
  2780. responses:
  2781. "200":
  2782. description: '{"success":true,"data":{},"msg":"发送成功"}'
  2783. schema:
  2784. type: string
  2785. security:
  2786. - ApiKeyAuth: []
  2787. summary: 发送邮件
  2788. tags:
  2789. - System
  2790. /deptUploadAndDownload/breakpointContinue:
  2791. post:
  2792. consumes:
  2793. - multipart/form-data
  2794. parameters:
  2795. - description: an example for breakpoint resume, 断点续传示例
  2796. in: formData
  2797. name: dept
  2798. required: true
  2799. type: dept
  2800. produces:
  2801. - application/json
  2802. responses:
  2803. "200":
  2804. description: 断点续传到服务器
  2805. schema:
  2806. allOf:
  2807. - $ref: '#/definitions/response.Response'
  2808. - properties:
  2809. msg:
  2810. type: string
  2811. type: object
  2812. security:
  2813. - ApiKeyAuth: []
  2814. summary: 断点续传到服务器
  2815. tags:
  2816. - ExaFileUploadAndDownload
  2817. /deptUploadAndDownload/deleteFile:
  2818. post:
  2819. parameters:
  2820. - description: 传入文件里面id即可
  2821. in: body
  2822. name: data
  2823. required: true
  2824. schema:
  2825. $ref: '#/definitions/example.ExaFileUploadAndDownload'
  2826. produces:
  2827. - application/json
  2828. responses:
  2829. "200":
  2830. description: 删除文件
  2831. schema:
  2832. allOf:
  2833. - $ref: '#/definitions/response.Response'
  2834. - properties:
  2835. msg:
  2836. type: string
  2837. type: object
  2838. security:
  2839. - ApiKeyAuth: []
  2840. summary: 删除文件
  2841. tags:
  2842. - ExaFileUploadAndDownload
  2843. /deptUploadAndDownload/findFile:
  2844. post:
  2845. consumes:
  2846. - multipart/form-data
  2847. parameters:
  2848. - description: 上传文件完成
  2849. in: formData
  2850. name: dept
  2851. required: true
  2852. type: dept
  2853. produces:
  2854. - application/json
  2855. responses:
  2856. "200":
  2857. description: 创建文件,返回包括文件路径
  2858. schema:
  2859. allOf:
  2860. - $ref: '#/definitions/response.Response'
  2861. - properties:
  2862. data:
  2863. $ref: '#/definitions/response.FilePathResponse'
  2864. msg:
  2865. type: string
  2866. type: object
  2867. security:
  2868. - ApiKeyAuth: []
  2869. summary: 创建文件
  2870. tags:
  2871. - ExaFileUploadAndDownload
  2872. /deptUploadAndDownload/getFileList:
  2873. post:
  2874. consumes:
  2875. - application/json
  2876. parameters:
  2877. - description: 页码, 每页大小
  2878. in: body
  2879. name: data
  2880. required: true
  2881. schema:
  2882. $ref: '#/definitions/request.PageInfo'
  2883. produces:
  2884. - application/json
  2885. responses:
  2886. "200":
  2887. description: 分页文件列表,返回包括列表,总数,页码,每页数量
  2888. schema:
  2889. allOf:
  2890. - $ref: '#/definitions/response.Response'
  2891. - properties:
  2892. data:
  2893. $ref: '#/definitions/response.PageResult'
  2894. msg:
  2895. type: string
  2896. type: object
  2897. security:
  2898. - ApiKeyAuth: []
  2899. summary: 分页文件列表
  2900. tags:
  2901. - ExaFileUploadAndDownload
  2902. /deptUploadAndDownload/removeChunk:
  2903. post:
  2904. consumes:
  2905. - multipart/form-data
  2906. parameters:
  2907. - description: 删除缓存切片
  2908. in: formData
  2909. name: dept
  2910. required: true
  2911. type: dept
  2912. produces:
  2913. - application/json
  2914. responses:
  2915. "200":
  2916. description: 删除切片
  2917. schema:
  2918. allOf:
  2919. - $ref: '#/definitions/response.Response'
  2920. - properties:
  2921. msg:
  2922. type: string
  2923. type: object
  2924. security:
  2925. - ApiKeyAuth: []
  2926. summary: 删除切片
  2927. tags:
  2928. - ExaFileUploadAndDownload
  2929. /deptUploadAndDownload/upload:
  2930. post:
  2931. consumes:
  2932. - multipart/form-data
  2933. parameters:
  2934. - description: 上传文件示例
  2935. in: formData
  2936. name: dept
  2937. required: true
  2938. type: dept
  2939. produces:
  2940. - application/json
  2941. responses:
  2942. "200":
  2943. description: 上传文件示例,返回包括文件详情
  2944. schema:
  2945. allOf:
  2946. - $ref: '#/definitions/response.Response'
  2947. - properties:
  2948. data:
  2949. $ref: '#/definitions/response.ExaFileResponse'
  2950. msg:
  2951. type: string
  2952. type: object
  2953. security:
  2954. - ApiKeyAuth: []
  2955. summary: 上传文件示例
  2956. tags:
  2957. - ExaFileUploadAndDownload
  2958. /init/checkdb:
  2959. post:
  2960. produces:
  2961. - application/json
  2962. responses:
  2963. "200":
  2964. description: 初始化用户数据库
  2965. schema:
  2966. allOf:
  2967. - $ref: '#/definitions/response.Response'
  2968. - properties:
  2969. data:
  2970. additionalProperties: true
  2971. type: object
  2972. msg:
  2973. type: string
  2974. type: object
  2975. summary: 初始化用户数据库
  2976. tags:
  2977. - CheckDB
  2978. /init/initdb:
  2979. post:
  2980. parameters:
  2981. - description: 初始化数据库参数
  2982. in: body
  2983. name: data
  2984. required: true
  2985. schema:
  2986. $ref: '#/definitions/request.InitDB'
  2987. produces:
  2988. - application/json
  2989. responses:
  2990. "200":
  2991. description: 初始化用户数据库
  2992. schema:
  2993. allOf:
  2994. - $ref: '#/definitions/response.Response'
  2995. - properties:
  2996. data:
  2997. type: string
  2998. type: object
  2999. summary: 初始化用户数据库
  3000. tags:
  3001. - InitDB
  3002. /jwt/jsonInBlacklist:
  3003. post:
  3004. consumes:
  3005. - application/json
  3006. produces:
  3007. - application/json
  3008. responses:
  3009. "200":
  3010. description: jwt加入黑名单
  3011. schema:
  3012. allOf:
  3013. - $ref: '#/definitions/response.Response'
  3014. - properties:
  3015. msg:
  3016. type: string
  3017. type: object
  3018. security:
  3019. - ApiKeyAuth: []
  3020. summary: jwt加入黑名单
  3021. tags:
  3022. - Jwt
  3023. /menu/addBaseMenu:
  3024. post:
  3025. consumes:
  3026. - application/json
  3027. parameters:
  3028. - description: 路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记
  3029. in: body
  3030. name: data
  3031. required: true
  3032. schema:
  3033. $ref: '#/definitions/system.SysBaseMenu'
  3034. produces:
  3035. - application/json
  3036. responses:
  3037. "200":
  3038. description: 新增菜单
  3039. schema:
  3040. allOf:
  3041. - $ref: '#/definitions/response.Response'
  3042. - properties:
  3043. msg:
  3044. type: string
  3045. type: object
  3046. security:
  3047. - ApiKeyAuth: []
  3048. summary: 新增菜单
  3049. tags:
  3050. - Menu
  3051. /menu/addMenuAuthority:
  3052. post:
  3053. consumes:
  3054. - application/json
  3055. parameters:
  3056. - description: 角色ID
  3057. in: body
  3058. name: data
  3059. required: true
  3060. schema:
  3061. $ref: '#/definitions/request.AddMenuAuthorityInfo'
  3062. produces:
  3063. - application/json
  3064. responses:
  3065. "200":
  3066. description: 增加menu和角色关联关系
  3067. schema:
  3068. allOf:
  3069. - $ref: '#/definitions/response.Response'
  3070. - properties:
  3071. msg:
  3072. type: string
  3073. type: object
  3074. security:
  3075. - ApiKeyAuth: []
  3076. summary: 增加menu和角色关联关系
  3077. tags:
  3078. - AuthorityMenu
  3079. /menu/deleteBaseMenu:
  3080. post:
  3081. consumes:
  3082. - application/json
  3083. parameters:
  3084. - description: 菜单id
  3085. in: body
  3086. name: data
  3087. required: true
  3088. schema:
  3089. $ref: '#/definitions/request.GetById'
  3090. produces:
  3091. - application/json
  3092. responses:
  3093. "200":
  3094. description: 删除菜单
  3095. schema:
  3096. allOf:
  3097. - $ref: '#/definitions/response.Response'
  3098. - properties:
  3099. msg:
  3100. type: string
  3101. type: object
  3102. security:
  3103. - ApiKeyAuth: []
  3104. summary: 删除菜单
  3105. tags:
  3106. - Menu
  3107. /menu/getBaseMenuById:
  3108. post:
  3109. consumes:
  3110. - application/json
  3111. parameters:
  3112. - description: 菜单id
  3113. in: body
  3114. name: data
  3115. required: true
  3116. schema:
  3117. $ref: '#/definitions/request.GetById'
  3118. produces:
  3119. - application/json
  3120. responses:
  3121. "200":
  3122. description: 根据id获取菜单,返回包括系统菜单列表
  3123. schema:
  3124. allOf:
  3125. - $ref: '#/definitions/response.Response'
  3126. - properties:
  3127. data:
  3128. $ref: '#/definitions/response.SysBaseMenuResponse'
  3129. msg:
  3130. type: string
  3131. type: object
  3132. security:
  3133. - ApiKeyAuth: []
  3134. summary: 根据id获取菜单
  3135. tags:
  3136. - Menu
  3137. /menu/getBaseMenuTree:
  3138. post:
  3139. parameters:
  3140. - description: 空
  3141. in: body
  3142. name: data
  3143. required: true
  3144. schema:
  3145. $ref: '#/definitions/request.Empty'
  3146. produces:
  3147. - application/json
  3148. responses:
  3149. "200":
  3150. description: 获取用户动态路由,返回包括系统菜单列表
  3151. schema:
  3152. allOf:
  3153. - $ref: '#/definitions/response.Response'
  3154. - properties:
  3155. data:
  3156. $ref: '#/definitions/response.SysBaseMenusResponse'
  3157. msg:
  3158. type: string
  3159. type: object
  3160. security:
  3161. - ApiKeyAuth: []
  3162. summary: 获取用户动态路由
  3163. tags:
  3164. - AuthorityMenu
  3165. /menu/getMenu:
  3166. post:
  3167. parameters:
  3168. - description: 空
  3169. in: body
  3170. name: data
  3171. required: true
  3172. schema:
  3173. $ref: '#/definitions/request.Empty'
  3174. produces:
  3175. - application/json
  3176. responses:
  3177. "200":
  3178. description: 获取用户动态路由,返回包括系统菜单详情列表
  3179. schema:
  3180. allOf:
  3181. - $ref: '#/definitions/response.Response'
  3182. - properties:
  3183. data:
  3184. $ref: '#/definitions/response.SysMenusResponse'
  3185. msg:
  3186. type: string
  3187. type: object
  3188. security:
  3189. - ApiKeyAuth: []
  3190. summary: 获取用户动态路由
  3191. tags:
  3192. - AuthorityMenu
  3193. /menu/getMenuAuthority:
  3194. post:
  3195. consumes:
  3196. - application/json
  3197. parameters:
  3198. - description: 角色ID
  3199. in: body
  3200. name: data
  3201. required: true
  3202. schema:
  3203. $ref: '#/definitions/request.GetAuthorityId'
  3204. produces:
  3205. - application/json
  3206. responses:
  3207. "200":
  3208. description: 获取指定角色menu
  3209. schema:
  3210. allOf:
  3211. - $ref: '#/definitions/response.Response'
  3212. - properties:
  3213. data:
  3214. additionalProperties: true
  3215. type: object
  3216. msg:
  3217. type: string
  3218. type: object
  3219. security:
  3220. - ApiKeyAuth: []
  3221. summary: 获取指定角色menu
  3222. tags:
  3223. - AuthorityMenu
  3224. /menu/getMenuList:
  3225. post:
  3226. consumes:
  3227. - application/json
  3228. parameters:
  3229. - description: 页码, 每页大小
  3230. in: body
  3231. name: data
  3232. required: true
  3233. schema:
  3234. $ref: '#/definitions/request.PageInfo'
  3235. produces:
  3236. - application/json
  3237. responses:
  3238. "200":
  3239. description: 分页获取基础menu列表,返回包括列表,总数,页码,每页数量
  3240. schema:
  3241. allOf:
  3242. - $ref: '#/definitions/response.Response'
  3243. - properties:
  3244. data:
  3245. $ref: '#/definitions/response.PageResult'
  3246. msg:
  3247. type: string
  3248. type: object
  3249. security:
  3250. - ApiKeyAuth: []
  3251. summary: 分页获取基础menu列表
  3252. tags:
  3253. - Menu
  3254. /menu/updateBaseMenu:
  3255. post:
  3256. consumes:
  3257. - application/json
  3258. parameters:
  3259. - description: 路由path, 父菜单ID, 路由name, 对应前端文件路径, 排序标记
  3260. in: body
  3261. name: data
  3262. required: true
  3263. schema:
  3264. $ref: '#/definitions/system.SysBaseMenu'
  3265. produces:
  3266. - application/json
  3267. responses:
  3268. "200":
  3269. description: 更新菜单
  3270. schema:
  3271. allOf:
  3272. - $ref: '#/definitions/response.Response'
  3273. - properties:
  3274. msg:
  3275. type: string
  3276. type: object
  3277. security:
  3278. - ApiKeyAuth: []
  3279. summary: 更新菜单
  3280. tags:
  3281. - Menu
  3282. /sysDictionary/createSysDictionary:
  3283. post:
  3284. consumes:
  3285. - application/json
  3286. parameters:
  3287. - description: SysDictionary模型
  3288. in: body
  3289. name: data
  3290. required: true
  3291. schema:
  3292. $ref: '#/definitions/system.SysDictionary'
  3293. produces:
  3294. - application/json
  3295. responses:
  3296. "200":
  3297. description: 创建SysDictionary
  3298. schema:
  3299. allOf:
  3300. - $ref: '#/definitions/response.Response'
  3301. - properties:
  3302. msg:
  3303. type: string
  3304. type: object
  3305. security:
  3306. - ApiKeyAuth: []
  3307. summary: 创建SysDictionary
  3308. tags:
  3309. - SysDictionary
  3310. /sysDictionary/deleteSysDictionary:
  3311. delete:
  3312. consumes:
  3313. - application/json
  3314. parameters:
  3315. - description: SysDictionary模型
  3316. in: body
  3317. name: data
  3318. required: true
  3319. schema:
  3320. $ref: '#/definitions/system.SysDictionary'
  3321. produces:
  3322. - application/json
  3323. responses:
  3324. "200":
  3325. description: 删除SysDictionary
  3326. schema:
  3327. allOf:
  3328. - $ref: '#/definitions/response.Response'
  3329. - properties:
  3330. msg:
  3331. type: string
  3332. type: object
  3333. security:
  3334. - ApiKeyAuth: []
  3335. summary: 删除SysDictionary
  3336. tags:
  3337. - SysDictionary
  3338. /sysDictionary/findSysDictionary:
  3339. get:
  3340. consumes:
  3341. - application/json
  3342. parameters:
  3343. - description: 主键ID
  3344. in: query
  3345. name: ID
  3346. type: integer
  3347. - description: 创建时间
  3348. in: query
  3349. name: createdAt
  3350. type: string
  3351. - description: 描述
  3352. in: query
  3353. name: desc
  3354. type: string
  3355. - description: 字典名(中)
  3356. in: query
  3357. name: name
  3358. type: string
  3359. - description: 状态
  3360. in: query
  3361. name: status
  3362. type: boolean
  3363. - description: 字典名(英)
  3364. in: query
  3365. name: type
  3366. type: string
  3367. - description: 更新时间
  3368. in: query
  3369. name: updatedAt
  3370. type: string
  3371. produces:
  3372. - application/json
  3373. responses:
  3374. "200":
  3375. description: 用id查询SysDictionary
  3376. schema:
  3377. allOf:
  3378. - $ref: '#/definitions/response.Response'
  3379. - properties:
  3380. data:
  3381. additionalProperties: true
  3382. type: object
  3383. msg:
  3384. type: string
  3385. type: object
  3386. security:
  3387. - ApiKeyAuth: []
  3388. summary: 用id查询SysDictionary
  3389. tags:
  3390. - SysDictionary
  3391. /sysDictionary/getSysDictionaryList:
  3392. get:
  3393. consumes:
  3394. - application/json
  3395. produces:
  3396. - application/json
  3397. responses:
  3398. "200":
  3399. description: 分页获取SysDictionary列表,返回包括列表,总数,页码,每页数量
  3400. schema:
  3401. allOf:
  3402. - $ref: '#/definitions/response.Response'
  3403. - properties:
  3404. data:
  3405. $ref: '#/definitions/response.PageResult'
  3406. msg:
  3407. type: string
  3408. type: object
  3409. security:
  3410. - ApiKeyAuth: []
  3411. summary: 分页获取SysDictionary列表
  3412. tags:
  3413. - SysDictionary
  3414. /sysDictionary/updateSysDictionary:
  3415. put:
  3416. consumes:
  3417. - application/json
  3418. parameters:
  3419. - description: SysDictionary模型
  3420. in: body
  3421. name: data
  3422. required: true
  3423. schema:
  3424. $ref: '#/definitions/system.SysDictionary'
  3425. produces:
  3426. - application/json
  3427. responses:
  3428. "200":
  3429. description: 更新SysDictionary
  3430. schema:
  3431. allOf:
  3432. - $ref: '#/definitions/response.Response'
  3433. - properties:
  3434. msg:
  3435. type: string
  3436. type: object
  3437. security:
  3438. - ApiKeyAuth: []
  3439. summary: 更新SysDictionary
  3440. tags:
  3441. - SysDictionary
  3442. /sysDictionaryDetail/createSysDictionaryDetail:
  3443. post:
  3444. consumes:
  3445. - application/json
  3446. parameters:
  3447. - description: SysDictionaryDetail模型
  3448. in: body
  3449. name: data
  3450. required: true
  3451. schema:
  3452. $ref: '#/definitions/system.SysDictionaryDetail'
  3453. produces:
  3454. - application/json
  3455. responses:
  3456. "200":
  3457. description: 创建SysDictionaryDetail
  3458. schema:
  3459. allOf:
  3460. - $ref: '#/definitions/response.Response'
  3461. - properties:
  3462. msg:
  3463. type: string
  3464. type: object
  3465. security:
  3466. - ApiKeyAuth: []
  3467. summary: 创建SysDictionaryDetail
  3468. tags:
  3469. - SysDictionaryDetail
  3470. /sysDictionaryDetail/deleteSysDictionaryDetail:
  3471. delete:
  3472. consumes:
  3473. - application/json
  3474. parameters:
  3475. - description: SysDictionaryDetail模型
  3476. in: body
  3477. name: data
  3478. required: true
  3479. schema:
  3480. $ref: '#/definitions/system.SysDictionaryDetail'
  3481. produces:
  3482. - application/json
  3483. responses:
  3484. "200":
  3485. description: 删除SysDictionaryDetail
  3486. schema:
  3487. allOf:
  3488. - $ref: '#/definitions/response.Response'
  3489. - properties:
  3490. msg:
  3491. type: string
  3492. type: object
  3493. security:
  3494. - ApiKeyAuth: []
  3495. summary: 删除SysDictionaryDetail
  3496. tags:
  3497. - SysDictionaryDetail
  3498. /sysDictionaryDetail/findSysDictionaryDetail:
  3499. get:
  3500. consumes:
  3501. - application/json
  3502. parameters:
  3503. - description: 主键ID
  3504. in: query
  3505. name: ID
  3506. type: integer
  3507. - description: 创建时间
  3508. in: query
  3509. name: createdAt
  3510. type: string
  3511. - description: 扩展值
  3512. in: query
  3513. name: extend
  3514. type: string
  3515. - description: 展示值
  3516. in: query
  3517. name: label
  3518. type: string
  3519. - description: 排序标记
  3520. in: query
  3521. name: sort
  3522. type: integer
  3523. - description: 启用状态
  3524. in: query
  3525. name: status
  3526. type: boolean
  3527. - description: 关联标记
  3528. in: query
  3529. name: sysDictionaryID
  3530. type: integer
  3531. - description: 更新时间
  3532. in: query
  3533. name: updatedAt
  3534. type: string
  3535. - description: 字典值
  3536. in: query
  3537. name: value
  3538. type: integer
  3539. produces:
  3540. - application/json
  3541. responses:
  3542. "200":
  3543. description: 用id查询SysDictionaryDetail
  3544. schema:
  3545. allOf:
  3546. - $ref: '#/definitions/response.Response'
  3547. - properties:
  3548. data:
  3549. additionalProperties: true
  3550. type: object
  3551. msg:
  3552. type: string
  3553. type: object
  3554. security:
  3555. - ApiKeyAuth: []
  3556. summary: 用id查询SysDictionaryDetail
  3557. tags:
  3558. - SysDictionaryDetail
  3559. /sysDictionaryDetail/getSysDictionaryDetailList:
  3560. get:
  3561. consumes:
  3562. - application/json
  3563. parameters:
  3564. - description: 主键ID
  3565. in: query
  3566. name: ID
  3567. type: integer
  3568. - description: 创建时间
  3569. in: query
  3570. name: createdAt
  3571. type: string
  3572. - description: 扩展值
  3573. in: query
  3574. name: extend
  3575. type: string
  3576. - description: 关键字
  3577. in: query
  3578. name: keyword
  3579. type: string
  3580. - description: 展示值
  3581. in: query
  3582. name: label
  3583. type: string
  3584. - description: 页码
  3585. in: query
  3586. name: page
  3587. type: integer
  3588. - description: 每页大小
  3589. in: query
  3590. name: pageSize
  3591. type: integer
  3592. - description: 排序标记
  3593. in: query
  3594. name: sort
  3595. type: integer
  3596. - description: 启用状态
  3597. in: query
  3598. name: status
  3599. type: boolean
  3600. - description: 关联标记
  3601. in: query
  3602. name: sysDictionaryID
  3603. type: integer
  3604. - description: 更新时间
  3605. in: query
  3606. name: updatedAt
  3607. type: string
  3608. - description: 字典值
  3609. in: query
  3610. name: value
  3611. type: integer
  3612. produces:
  3613. - application/json
  3614. responses:
  3615. "200":
  3616. description: 分页获取SysDictionaryDetail列表,返回包括列表,总数,页码,每页数量
  3617. schema:
  3618. allOf:
  3619. - $ref: '#/definitions/response.Response'
  3620. - properties:
  3621. data:
  3622. $ref: '#/definitions/response.PageResult'
  3623. msg:
  3624. type: string
  3625. type: object
  3626. security:
  3627. - ApiKeyAuth: []
  3628. summary: 分页获取SysDictionaryDetail列表
  3629. tags:
  3630. - SysDictionaryDetail
  3631. /sysDictionaryDetail/updateSysDictionaryDetail:
  3632. put:
  3633. consumes:
  3634. - application/json
  3635. parameters:
  3636. - description: 更新SysDictionaryDetail
  3637. in: body
  3638. name: data
  3639. required: true
  3640. schema:
  3641. $ref: '#/definitions/system.SysDictionaryDetail'
  3642. produces:
  3643. - application/json
  3644. responses:
  3645. "200":
  3646. description: 更新SysDictionaryDetail
  3647. schema:
  3648. allOf:
  3649. - $ref: '#/definitions/response.Response'
  3650. - properties:
  3651. msg:
  3652. type: string
  3653. type: object
  3654. security:
  3655. - ApiKeyAuth: []
  3656. summary: 更新SysDictionaryDetail
  3657. tags:
  3658. - SysDictionaryDetail
  3659. /sysOperationRecord/createSysOperationRecord:
  3660. post:
  3661. consumes:
  3662. - application/json
  3663. parameters:
  3664. - description: 创建SysOperationRecord
  3665. in: body
  3666. name: data
  3667. required: true
  3668. schema:
  3669. $ref: '#/definitions/system.SysOperationRecord'
  3670. produces:
  3671. - application/json
  3672. responses:
  3673. "200":
  3674. description: 创建SysOperationRecord
  3675. schema:
  3676. allOf:
  3677. - $ref: '#/definitions/response.Response'
  3678. - properties:
  3679. msg:
  3680. type: string
  3681. type: object
  3682. security:
  3683. - ApiKeyAuth: []
  3684. summary: 创建SysOperationRecord
  3685. tags:
  3686. - SysOperationRecord
  3687. /sysOperationRecord/deleteSysOperationRecord:
  3688. delete:
  3689. consumes:
  3690. - application/json
  3691. parameters:
  3692. - description: SysOperationRecord模型
  3693. in: body
  3694. name: data
  3695. required: true
  3696. schema:
  3697. $ref: '#/definitions/system.SysOperationRecord'
  3698. produces:
  3699. - application/json
  3700. responses:
  3701. "200":
  3702. description: 删除SysOperationRecord
  3703. schema:
  3704. allOf:
  3705. - $ref: '#/definitions/response.Response'
  3706. - properties:
  3707. msg:
  3708. type: string
  3709. type: object
  3710. security:
  3711. - ApiKeyAuth: []
  3712. summary: 删除SysOperationRecord
  3713. tags:
  3714. - SysOperationRecord
  3715. /sysOperationRecord/deleteSysOperationRecordByIds:
  3716. delete:
  3717. consumes:
  3718. - application/json
  3719. parameters:
  3720. - description: 批量删除SysOperationRecord
  3721. in: body
  3722. name: data
  3723. required: true
  3724. schema:
  3725. $ref: '#/definitions/request.IdsReq'
  3726. produces:
  3727. - application/json
  3728. responses:
  3729. "200":
  3730. description: 批量删除SysOperationRecord
  3731. schema:
  3732. allOf:
  3733. - $ref: '#/definitions/response.Response'
  3734. - properties:
  3735. msg:
  3736. type: string
  3737. type: object
  3738. security:
  3739. - ApiKeyAuth: []
  3740. summary: 批量删除SysOperationRecord
  3741. tags:
  3742. - SysOperationRecord
  3743. /sysOperationRecord/findSysOperationRecord:
  3744. get:
  3745. consumes:
  3746. - application/json
  3747. parameters:
  3748. - description: 主键ID
  3749. in: query
  3750. name: ID
  3751. type: integer
  3752. - description: 代理
  3753. in: query
  3754. name: agent
  3755. type: string
  3756. - description: 请求Body
  3757. in: query
  3758. name: body
  3759. type: string
  3760. - description: 创建时间
  3761. in: query
  3762. name: createdAt
  3763. type: string
  3764. - description: 错误信息
  3765. in: query
  3766. name: error_message
  3767. type: string
  3768. - description: 请求ip
  3769. in: query
  3770. name: ip
  3771. type: string
  3772. - description: 延迟
  3773. in: query
  3774. name: latency
  3775. type: string
  3776. - description: 请求方法
  3777. in: query
  3778. name: method
  3779. type: string
  3780. - description: 请求路径
  3781. in: query
  3782. name: path
  3783. type: string
  3784. - description: 响应Body
  3785. in: query
  3786. name: resp
  3787. type: string
  3788. - description: 请求状态
  3789. in: query
  3790. name: status
  3791. type: integer
  3792. - description: 更新时间
  3793. in: query
  3794. name: updatedAt
  3795. type: string
  3796. - description: 用户id
  3797. in: query
  3798. name: user_id
  3799. type: integer
  3800. produces:
  3801. - application/json
  3802. responses:
  3803. "200":
  3804. description: 用id查询SysOperationRecord
  3805. schema:
  3806. allOf:
  3807. - $ref: '#/definitions/response.Response'
  3808. - properties:
  3809. data:
  3810. additionalProperties: true
  3811. type: object
  3812. msg:
  3813. type: string
  3814. type: object
  3815. security:
  3816. - ApiKeyAuth: []
  3817. summary: 用id查询SysOperationRecord
  3818. tags:
  3819. - SysOperationRecord
  3820. /sysOperationRecord/getSysOperationRecordList:
  3821. get:
  3822. consumes:
  3823. - application/json
  3824. parameters:
  3825. - description: 主键ID
  3826. in: query
  3827. name: ID
  3828. type: integer
  3829. - description: 代理
  3830. in: query
  3831. name: agent
  3832. type: string
  3833. - description: 请求Body
  3834. in: query
  3835. name: body
  3836. type: string
  3837. - description: 创建时间
  3838. in: query
  3839. name: createdAt
  3840. type: string
  3841. - description: 错误信息
  3842. in: query
  3843. name: error_message
  3844. type: string
  3845. - description: 请求ip
  3846. in: query
  3847. name: ip
  3848. type: string
  3849. - description: 关键字
  3850. in: query
  3851. name: keyword
  3852. type: string
  3853. - description: 延迟
  3854. in: query
  3855. name: latency
  3856. type: string
  3857. - description: 请求方法
  3858. in: query
  3859. name: method
  3860. type: string
  3861. - description: 页码
  3862. in: query
  3863. name: page
  3864. type: integer
  3865. - description: 每页大小
  3866. in: query
  3867. name: pageSize
  3868. type: integer
  3869. - description: 请求路径
  3870. in: query
  3871. name: path
  3872. type: string
  3873. - description: 响应Body
  3874. in: query
  3875. name: resp
  3876. type: string
  3877. - description: 请求状态
  3878. in: query
  3879. name: status
  3880. type: integer
  3881. - description: 更新时间
  3882. in: query
  3883. name: updatedAt
  3884. type: string
  3885. - description: 用户id
  3886. in: query
  3887. name: user_id
  3888. type: integer
  3889. produces:
  3890. - application/json
  3891. responses:
  3892. "200":
  3893. description: 分页获取SysOperationRecord列表,返回包括列表,总数,页码,每页数量
  3894. schema:
  3895. allOf:
  3896. - $ref: '#/definitions/response.Response'
  3897. - properties:
  3898. data:
  3899. $ref: '#/definitions/response.PageResult'
  3900. msg:
  3901. type: string
  3902. type: object
  3903. security:
  3904. - ApiKeyAuth: []
  3905. summary: 分页获取SysOperationRecord列表
  3906. tags:
  3907. - SysOperationRecord
  3908. /system/getServerInfo:
  3909. post:
  3910. produces:
  3911. - application/json
  3912. responses:
  3913. "200":
  3914. description: 获取服务器信息
  3915. schema:
  3916. allOf:
  3917. - $ref: '#/definitions/response.Response'
  3918. - properties:
  3919. data:
  3920. additionalProperties: true
  3921. type: object
  3922. msg:
  3923. type: string
  3924. type: object
  3925. security:
  3926. - ApiKeyAuth: []
  3927. summary: 获取服务器信息
  3928. tags:
  3929. - System
  3930. /system/getSystemConfig:
  3931. post:
  3932. produces:
  3933. - application/json
  3934. responses:
  3935. "200":
  3936. description: 获取配置文件内容,返回包括系统配置
  3937. schema:
  3938. allOf:
  3939. - $ref: '#/definitions/response.Response'
  3940. - properties:
  3941. data:
  3942. $ref: '#/definitions/response.SysConfigResponse'
  3943. msg:
  3944. type: string
  3945. type: object
  3946. security:
  3947. - ApiKeyAuth: []
  3948. summary: 获取配置文件内容
  3949. tags:
  3950. - System
  3951. /system/reloadSystem:
  3952. post:
  3953. produces:
  3954. - application/json
  3955. responses:
  3956. "200":
  3957. description: 重启系统
  3958. schema:
  3959. allOf:
  3960. - $ref: '#/definitions/response.Response'
  3961. - properties:
  3962. msg:
  3963. type: string
  3964. type: object
  3965. security:
  3966. - ApiKeyAuth: []
  3967. summary: 重启系统
  3968. tags:
  3969. - System
  3970. /system/setSystemConfig:
  3971. post:
  3972. parameters:
  3973. - description: 设置配置文件内容
  3974. in: body
  3975. name: data
  3976. required: true
  3977. schema:
  3978. $ref: '#/definitions/system.System'
  3979. produces:
  3980. - application/json
  3981. responses:
  3982. "200":
  3983. description: 设置配置文件内容
  3984. schema:
  3985. allOf:
  3986. - $ref: '#/definitions/response.Response'
  3987. - properties:
  3988. data:
  3989. type: string
  3990. type: object
  3991. security:
  3992. - ApiKeyAuth: []
  3993. summary: 设置配置文件内容
  3994. tags:
  3995. - System
  3996. /user/SetSelfInfo:
  3997. put:
  3998. consumes:
  3999. - application/json
  4000. parameters:
  4001. - description: ID, 用户名, 昵称, 头像链接
  4002. in: body
  4003. name: data
  4004. required: true
  4005. schema:
  4006. $ref: '#/definitions/system.SysUser'
  4007. produces:
  4008. - application/json
  4009. responses:
  4010. "200":
  4011. description: 设置用户信息
  4012. schema:
  4013. allOf:
  4014. - $ref: '#/definitions/response.Response'
  4015. - properties:
  4016. data:
  4017. additionalProperties: true
  4018. type: object
  4019. msg:
  4020. type: string
  4021. type: object
  4022. security:
  4023. - ApiKeyAuth: []
  4024. summary: 设置用户信息
  4025. tags:
  4026. - SysUser
  4027. /user/admin_register:
  4028. post:
  4029. parameters:
  4030. - description: 用户名, 昵称, 密码, 角色ID
  4031. in: body
  4032. name: data
  4033. required: true
  4034. schema:
  4035. $ref: '#/definitions/request.Register'
  4036. produces:
  4037. - application/json
  4038. responses:
  4039. "200":
  4040. description: 用户注册账号,返回包括用户信息
  4041. schema:
  4042. allOf:
  4043. - $ref: '#/definitions/response.Response'
  4044. - properties:
  4045. data:
  4046. $ref: '#/definitions/response.SysUserResponse'
  4047. msg:
  4048. type: string
  4049. type: object
  4050. summary: 用户注册账号
  4051. tags:
  4052. - SysUser
  4053. /user/changePassword:
  4054. post:
  4055. parameters:
  4056. - description: 用户名, 原密码, 新密码
  4057. in: body
  4058. name: data
  4059. required: true
  4060. schema:
  4061. $ref: '#/definitions/request.ChangePasswordReq'
  4062. produces:
  4063. - application/json
  4064. responses:
  4065. "200":
  4066. description: 用户修改密码
  4067. schema:
  4068. allOf:
  4069. - $ref: '#/definitions/response.Response'
  4070. - properties:
  4071. msg:
  4072. type: string
  4073. type: object
  4074. security:
  4075. - ApiKeyAuth: []
  4076. summary: 用户修改密码
  4077. tags:
  4078. - SysUser
  4079. /user/deleteUser:
  4080. delete:
  4081. consumes:
  4082. - application/json
  4083. parameters:
  4084. - description: 用户ID
  4085. in: body
  4086. name: data
  4087. required: true
  4088. schema:
  4089. $ref: '#/definitions/request.GetById'
  4090. produces:
  4091. - application/json
  4092. responses:
  4093. "200":
  4094. description: 删除用户
  4095. schema:
  4096. allOf:
  4097. - $ref: '#/definitions/response.Response'
  4098. - properties:
  4099. msg:
  4100. type: string
  4101. type: object
  4102. security:
  4103. - ApiKeyAuth: []
  4104. summary: 删除用户
  4105. tags:
  4106. - SysUser
  4107. /user/getUserInfo:
  4108. get:
  4109. consumes:
  4110. - application/json
  4111. produces:
  4112. - application/json
  4113. responses:
  4114. "200":
  4115. description: 获取用户信息
  4116. schema:
  4117. allOf:
  4118. - $ref: '#/definitions/response.Response'
  4119. - properties:
  4120. data:
  4121. additionalProperties: true
  4122. type: object
  4123. msg:
  4124. type: string
  4125. type: object
  4126. security:
  4127. - ApiKeyAuth: []
  4128. summary: 获取用户信息
  4129. tags:
  4130. - SysUser
  4131. /user/getUserList:
  4132. post:
  4133. consumes:
  4134. - application/json
  4135. parameters:
  4136. - description: 页码, 每页大小
  4137. in: body
  4138. name: data
  4139. required: true
  4140. schema:
  4141. $ref: '#/definitions/request.PageInfo'
  4142. produces:
  4143. - application/json
  4144. responses:
  4145. "200":
  4146. description: 分页获取用户列表,返回包括列表,总数,页码,每页数量
  4147. schema:
  4148. allOf:
  4149. - $ref: '#/definitions/response.Response'
  4150. - properties:
  4151. data:
  4152. $ref: '#/definitions/response.PageResult'
  4153. msg:
  4154. type: string
  4155. type: object
  4156. security:
  4157. - ApiKeyAuth: []
  4158. summary: 分页获取用户列表
  4159. tags:
  4160. - SysUser
  4161. /user/resetPassword:
  4162. post:
  4163. parameters:
  4164. - description: ID
  4165. in: body
  4166. name: data
  4167. required: true
  4168. schema:
  4169. $ref: '#/definitions/system.SysUser'
  4170. produces:
  4171. - application/json
  4172. responses:
  4173. "200":
  4174. description: 重置用户密码
  4175. schema:
  4176. allOf:
  4177. - $ref: '#/definitions/response.Response'
  4178. - properties:
  4179. msg:
  4180. type: string
  4181. type: object
  4182. security:
  4183. - ApiKeyAuth: []
  4184. summary: 重置用户密码
  4185. tags:
  4186. - SysUser
  4187. /user/setUserAuthorities:
  4188. post:
  4189. consumes:
  4190. - application/json
  4191. parameters:
  4192. - description: 用户UUID, 角色ID
  4193. in: body
  4194. name: data
  4195. required: true
  4196. schema:
  4197. $ref: '#/definitions/request.SetUserAuthorities'
  4198. produces:
  4199. - application/json
  4200. responses:
  4201. "200":
  4202. description: 设置用户权限
  4203. schema:
  4204. allOf:
  4205. - $ref: '#/definitions/response.Response'
  4206. - properties:
  4207. msg:
  4208. type: string
  4209. type: object
  4210. security:
  4211. - ApiKeyAuth: []
  4212. summary: 设置用户权限
  4213. tags:
  4214. - SysUser
  4215. /user/setUserAuthority:
  4216. post:
  4217. consumes:
  4218. - application/json
  4219. parameters:
  4220. - description: 用户UUID, 角色ID
  4221. in: body
  4222. name: data
  4223. required: true
  4224. schema:
  4225. $ref: '#/definitions/request.SetUserAuth'
  4226. produces:
  4227. - application/json
  4228. responses:
  4229. "200":
  4230. description: 设置用户权限
  4231. schema:
  4232. allOf:
  4233. - $ref: '#/definitions/response.Response'
  4234. - properties:
  4235. msg:
  4236. type: string
  4237. type: object
  4238. security:
  4239. - ApiKeyAuth: []
  4240. summary: 更改用户权限
  4241. tags:
  4242. - SysUser
  4243. /user/setUserInfo:
  4244. put:
  4245. consumes:
  4246. - application/json
  4247. parameters:
  4248. - description: ID, 用户名, 昵称, 头像链接
  4249. in: body
  4250. name: data
  4251. required: true
  4252. schema:
  4253. $ref: '#/definitions/system.SysUser'
  4254. produces:
  4255. - application/json
  4256. responses:
  4257. "200":
  4258. description: 设置用户信息
  4259. schema:
  4260. allOf:
  4261. - $ref: '#/definitions/response.Response'
  4262. - properties:
  4263. data:
  4264. additionalProperties: true
  4265. type: object
  4266. msg:
  4267. type: string
  4268. type: object
  4269. security:
  4270. - ApiKeyAuth: []
  4271. summary: 设置用户信息
  4272. tags:
  4273. - SysUser
  4274. securityDefinitions:
  4275. ApiKeyAuth:
  4276. in: header
  4277. name: x-token
  4278. type: apiKey
  4279. swagger: "2.0"