swagger.yaml 88 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822
  1. definitions:
  2. controller.AddDepartmentItemReqVO:
  3. properties:
  4. managerAdminIDList:
  5. example:
  6. - 1
  7. items:
  8. type: integer
  9. type: array
  10. name:
  11. example: 研发部
  12. type: string
  13. type: object
  14. controller.AddDepartmentItemRespVO:
  15. properties:
  16. id:
  17. type: integer
  18. managerAdminIDList:
  19. example:
  20. - 1
  21. items:
  22. type: integer
  23. type: array
  24. name:
  25. example: 研发部
  26. type: string
  27. type: object
  28. controller.AddEmployeeItemVO:
  29. properties:
  30. deptIDList:
  31. items:
  32. type: integer
  33. type: array
  34. email:
  35. type: string
  36. occIDList:
  37. items:
  38. type: integer
  39. type: array
  40. password:
  41. type: string
  42. phone:
  43. type: string
  44. realName:
  45. type: string
  46. type: object
  47. controller.AddOccupationReqVO:
  48. properties:
  49. name:
  50. type: string
  51. type: object
  52. controller.AddOccupationRespVO:
  53. properties:
  54. id:
  55. type: integer
  56. name:
  57. type: string
  58. type: object
  59. controller.AttachUserToDepartmentReqVO:
  60. properties:
  61. phone:
  62. type: string
  63. type: object
  64. controller.AttachUserToDepartmentRespVO:
  65. properties:
  66. deptID:
  67. type: integer
  68. type: object
  69. controller.BatchAddDepartmentItemReqVO:
  70. properties:
  71. departmentItemList:
  72. items:
  73. $ref: '#/definitions/controller.AddDepartmentItemReqVO'
  74. type: array
  75. type: object
  76. controller.BatchAddDepartmentItemRespVO:
  77. properties:
  78. departmentCreated:
  79. items:
  80. $ref: '#/definitions/controller.AddDepartmentItemRespVO'
  81. type: array
  82. type: object
  83. controller.BatchAddEmployeeReqVO:
  84. properties:
  85. employees:
  86. items:
  87. $ref: '#/definitions/controller.AddEmployeeItemVO'
  88. type: array
  89. type: object
  90. controller.BatchAddOccupationReqVO:
  91. properties:
  92. occupationList:
  93. items:
  94. $ref: '#/definitions/controller.AddOccupationReqVO'
  95. type: array
  96. type: object
  97. controller.BatchAddOccupationRespVO:
  98. properties:
  99. occupationCreated:
  100. items:
  101. $ref: '#/definitions/controller.AddOccupationRespVO'
  102. type: array
  103. type: object
  104. controller.BatchLinkUsersToOccupationReqVO:
  105. properties:
  106. users:
  107. items:
  108. type: integer
  109. type: array
  110. type: object
  111. controller.BatchTagWithDepartmentAndOccupationReqVO:
  112. properties:
  113. deptIDList:
  114. items:
  115. type: integer
  116. type: array
  117. employeeIDList:
  118. items:
  119. type: integer
  120. type: array
  121. occupationIDList:
  122. items:
  123. type: integer
  124. type: array
  125. type: object
  126. controller.DepartmentItemVO:
  127. properties:
  128. children:
  129. items:
  130. $ref: '#/definitions/controller.DepartmentItemVO'
  131. type: array
  132. id:
  133. type: integer
  134. managerList:
  135. items:
  136. properties:
  137. adminId:
  138. type: integer
  139. name:
  140. type: string
  141. type: object
  142. type: array
  143. name:
  144. example: 研发部
  145. type: string
  146. parentId:
  147. type: integer
  148. type: object
  149. controller.ErrVO:
  150. properties:
  151. code:
  152. type: integer
  153. msg:
  154. type: string
  155. type: object
  156. controller.ListEmployeeItemVO:
  157. properties:
  158. deptNames:
  159. items:
  160. type: string
  161. type: array
  162. id:
  163. type: integer
  164. name:
  165. type: string
  166. occNames:
  167. items:
  168. type: string
  169. type: array
  170. phone:
  171. type: string
  172. type: object
  173. controller.ListEmployeeRespVO:
  174. properties:
  175. employees:
  176. items:
  177. $ref: '#/definitions/controller.ListEmployeeItemVO'
  178. type: array
  179. total:
  180. type: integer
  181. type: object
  182. controller.ListOccupationItemVO:
  183. properties:
  184. createdTime:
  185. example: 2006-01-02T15:04:05Z07:00
  186. type: string
  187. id:
  188. type: integer
  189. name:
  190. type: string
  191. userCnt:
  192. type: integer
  193. type: object
  194. controller.ListOccupationUsersRespVO:
  195. properties:
  196. occID:
  197. type: integer
  198. users:
  199. items:
  200. $ref: '#/definitions/controller.OccupationLinkedUserVO'
  201. type: array
  202. type: object
  203. controller.ListOccupationVO:
  204. properties:
  205. occupationItems:
  206. items:
  207. $ref: '#/definitions/controller.ListOccupationItemVO'
  208. type: array
  209. total:
  210. type: integer
  211. type: object
  212. controller.ListUsersOfDepartmentsRespVO:
  213. properties:
  214. departments:
  215. items:
  216. $ref: '#/definitions/controller.UsersOfDepartmentVO'
  217. type: array
  218. type: object
  219. controller.OccupationLinkedUserVO:
  220. properties:
  221. deptNameList:
  222. items:
  223. type: string
  224. type: array
  225. id:
  226. type: integer
  227. name:
  228. type: string
  229. occNameList:
  230. items:
  231. type: string
  232. type: array
  233. phone:
  234. example: "17744533458"
  235. type: string
  236. type: object
  237. controller.UpdateDepartmentReqVO:
  238. properties:
  239. adminIDList:
  240. items:
  241. type: integer
  242. type: array
  243. name:
  244. example: 研发部
  245. type: string
  246. parentID:
  247. type: integer
  248. type: object
  249. controller.UpdateDepartmentRespVO:
  250. properties:
  251. adminIDList:
  252. items:
  253. type: integer
  254. type: array
  255. id:
  256. type: integer
  257. name:
  258. example: 研发部
  259. type: string
  260. parentID:
  261. type: integer
  262. type: object
  263. controller.UpdateEmployeeItemVO:
  264. properties:
  265. deptIDList:
  266. items:
  267. type: integer
  268. type: array
  269. email:
  270. type: string
  271. occIDList:
  272. items:
  273. type: integer
  274. type: array
  275. password:
  276. type: string
  277. phone:
  278. type: string
  279. realName:
  280. type: string
  281. type: object
  282. controller.UpdateOccupationReqVO:
  283. properties:
  284. name:
  285. type: string
  286. type: object
  287. controller.UserLoginReqVO:
  288. properties:
  289. fromFlag:
  290. type: string
  291. passwd:
  292. type: string
  293. phone:
  294. type: string
  295. type: object
  296. controller.UserLoginRespVO:
  297. properties:
  298. token:
  299. description: Token 认证字段
  300. type: string
  301. type: object
  302. controller.UserOfDepartmentItemVO:
  303. properties:
  304. id:
  305. type: integer
  306. name:
  307. type: string
  308. phone:
  309. type: string
  310. type: object
  311. controller.UserRegisterReqVO:
  312. properties:
  313. fromFlag:
  314. description: 从哪里获得,分析租户或组织用
  315. type: string
  316. passwd:
  317. type: string
  318. phone:
  319. example: "17744533454"
  320. type: string
  321. verifyCode:
  322. type: string
  323. type: object
  324. controller.UserRegisterRespVO:
  325. properties:
  326. token:
  327. description: Token 认证字段
  328. type: string
  329. type: object
  330. controller.UserUpdateDepartmentReqVO:
  331. properties:
  332. orgCode:
  333. type: string
  334. type: object
  335. controller.UserUpdateDepartmentRespVO:
  336. properties:
  337. orgID:
  338. type: integer
  339. redirectBaseUrl:
  340. type: string
  341. type: object
  342. controller.UsersOfDepartmentVO:
  343. properties:
  344. deptID:
  345. type: integer
  346. users:
  347. items:
  348. $ref: '#/definitions/controller.UserOfDepartmentItemVO'
  349. type: array
  350. type: object
  351. dto.GetSetSysConfigReq:
  352. properties:
  353. configKey:
  354. type: string
  355. configValue:
  356. type: string
  357. type: object
  358. dto.PassWord:
  359. properties:
  360. newPassword:
  361. type: string
  362. oldPassword:
  363. type: string
  364. type: object
  365. dto.ResetSysUserPwdReq:
  366. properties:
  367. createBy:
  368. type: integer
  369. password:
  370. type: string
  371. updateBy:
  372. type: integer
  373. userId:
  374. description: 用户ID
  375. type: integer
  376. type: object
  377. dto.RoleDataScopeReq:
  378. properties:
  379. dataScope:
  380. type: string
  381. deptIds:
  382. items:
  383. type: integer
  384. type: array
  385. roleId:
  386. type: integer
  387. required:
  388. - dataScope
  389. - roleId
  390. type: object
  391. dto.SysApiDeleteReq:
  392. properties:
  393. ids:
  394. items:
  395. type: integer
  396. type: array
  397. type: object
  398. dto.SysApiUpdateReq:
  399. properties:
  400. action:
  401. type: string
  402. createBy:
  403. type: integer
  404. handle:
  405. type: string
  406. id:
  407. description: 编码
  408. type: integer
  409. path:
  410. type: string
  411. title:
  412. type: string
  413. type:
  414. type: string
  415. updateBy:
  416. type: integer
  417. type: object
  418. dto.SysConfigByKeyReq:
  419. properties:
  420. configKey:
  421. type: string
  422. type: object
  423. dto.SysConfigControl:
  424. properties:
  425. configKey:
  426. type: string
  427. configName:
  428. type: string
  429. configType:
  430. type: string
  431. configValue:
  432. type: string
  433. createBy:
  434. type: integer
  435. id:
  436. description: 编码
  437. type: integer
  438. isFrontend:
  439. type: integer
  440. remark:
  441. type: string
  442. updateBy:
  443. type: integer
  444. type: object
  445. dto.SysDeptDeleteReq:
  446. properties:
  447. ids:
  448. items:
  449. type: integer
  450. type: array
  451. type: object
  452. dto.SysDeptInsertReq:
  453. properties:
  454. createBy:
  455. type: integer
  456. deptId:
  457. description: 编码
  458. type: integer
  459. deptName:
  460. description: 部门名称
  461. type: string
  462. deptPath:
  463. description: 路径
  464. type: string
  465. email:
  466. description: 邮箱
  467. type: string
  468. leader:
  469. description: 负责人
  470. type: string
  471. parentId:
  472. description: 上级部门
  473. type: integer
  474. phone:
  475. description: 手机
  476. type: string
  477. sort:
  478. description: 排序
  479. type: integer
  480. status:
  481. description: 状态
  482. type: integer
  483. updateBy:
  484. type: integer
  485. type: object
  486. dto.SysDeptUpdateReq:
  487. properties:
  488. createBy:
  489. type: integer
  490. deptId:
  491. description: 编码
  492. type: integer
  493. deptName:
  494. description: 部门名称
  495. type: string
  496. deptPath:
  497. description: 路径
  498. type: string
  499. email:
  500. description: 邮箱
  501. type: string
  502. leader:
  503. description: 负责人
  504. type: string
  505. parentId:
  506. description: 上级部门
  507. type: integer
  508. phone:
  509. description: 手机
  510. type: string
  511. sort:
  512. description: 排序
  513. type: integer
  514. status:
  515. description: 状态
  516. type: integer
  517. updateBy:
  518. type: integer
  519. type: object
  520. dto.SysDictDataDeleteReq:
  521. properties:
  522. createBy:
  523. type: integer
  524. ids:
  525. items:
  526. type: integer
  527. type: array
  528. updateBy:
  529. type: integer
  530. type: object
  531. dto.SysDictDataGetAllResp:
  532. properties:
  533. label:
  534. type: string
  535. value:
  536. type: string
  537. type: object
  538. dto.SysDictDataInsertReq:
  539. properties:
  540. createBy:
  541. type: integer
  542. cssClass:
  543. type: string
  544. default:
  545. type: string
  546. dictLabel:
  547. type: string
  548. dictSort:
  549. type: integer
  550. dictType:
  551. type: string
  552. dictValue:
  553. type: string
  554. isDefault:
  555. type: string
  556. listClass:
  557. type: string
  558. remark:
  559. type: string
  560. status:
  561. type: integer
  562. updateBy:
  563. type: integer
  564. type: object
  565. dto.SysDictDataUpdateReq:
  566. properties:
  567. createBy:
  568. type: integer
  569. cssClass:
  570. type: string
  571. default:
  572. type: string
  573. dictLabel:
  574. type: string
  575. dictSort:
  576. type: integer
  577. dictType:
  578. type: string
  579. dictValue:
  580. type: string
  581. id:
  582. type: integer
  583. isDefault:
  584. type: string
  585. listClass:
  586. type: string
  587. remark:
  588. type: string
  589. status:
  590. type: integer
  591. updateBy:
  592. type: integer
  593. type: object
  594. dto.SysDictTypeDeleteReq:
  595. properties:
  596. createBy:
  597. type: integer
  598. ids:
  599. items:
  600. type: integer
  601. type: array
  602. updateBy:
  603. type: integer
  604. type: object
  605. dto.SysDictTypeInsertReq:
  606. properties:
  607. createBy:
  608. type: integer
  609. dictName:
  610. type: string
  611. dictType:
  612. type: string
  613. id:
  614. type: integer
  615. remark:
  616. type: string
  617. status:
  618. type: integer
  619. updateBy:
  620. type: integer
  621. type: object
  622. dto.SysDictTypeUpdateReq:
  623. properties:
  624. createBy:
  625. type: integer
  626. dictName:
  627. type: string
  628. dictType:
  629. type: string
  630. id:
  631. type: integer
  632. remark:
  633. type: string
  634. status:
  635. type: integer
  636. updateBy:
  637. type: integer
  638. type: object
  639. dto.SysLoginLogDeleteReq:
  640. properties:
  641. ids:
  642. items:
  643. type: integer
  644. type: array
  645. type: object
  646. dto.SysMenuDeleteReq:
  647. properties:
  648. createBy:
  649. type: integer
  650. ids:
  651. items:
  652. type: integer
  653. type: array
  654. updateBy:
  655. type: integer
  656. type: object
  657. dto.SysMenuInsertReq:
  658. properties:
  659. action:
  660. description: 请求方式
  661. type: string
  662. apis:
  663. items:
  664. type: integer
  665. type: array
  666. breadcrumb:
  667. description: 是否面包屑
  668. type: string
  669. component:
  670. description: 组件
  671. type: string
  672. createBy:
  673. type: integer
  674. icon:
  675. description: 图标
  676. type: string
  677. isFrame:
  678. description: 是否frame
  679. type: string
  680. menuId:
  681. description: 编码
  682. type: integer
  683. menuName:
  684. description: 菜单name
  685. type: string
  686. menuType:
  687. description: 菜单类型
  688. type: string
  689. noCache:
  690. description: 是否缓存
  691. type: boolean
  692. parentId:
  693. description: 上级菜单
  694. type: integer
  695. path:
  696. description: 路径
  697. type: string
  698. paths:
  699. description: id路径
  700. type: string
  701. permission:
  702. description: 权限编码
  703. type: string
  704. sort:
  705. description: 排序
  706. type: integer
  707. sysApi:
  708. items:
  709. $ref: '#/definitions/models.SysApi'
  710. type: array
  711. title:
  712. description: 显示名称
  713. type: string
  714. updateBy:
  715. type: integer
  716. visible:
  717. description: 是否显示
  718. type: string
  719. type: object
  720. dto.SysMenuUpdateReq:
  721. properties:
  722. action:
  723. description: 请求方式
  724. type: string
  725. apis:
  726. items:
  727. type: integer
  728. type: array
  729. breadcrumb:
  730. description: 是否面包屑
  731. type: string
  732. component:
  733. description: 组件
  734. type: string
  735. createBy:
  736. type: integer
  737. icon:
  738. description: 图标
  739. type: string
  740. isFrame:
  741. description: 是否frame
  742. type: string
  743. menuId:
  744. description: 编码
  745. type: integer
  746. menuName:
  747. description: 菜单name
  748. type: string
  749. menuType:
  750. description: 菜单类型
  751. type: string
  752. noCache:
  753. description: 是否缓存
  754. type: boolean
  755. parentId:
  756. description: 上级菜单
  757. type: integer
  758. path:
  759. description: 路径
  760. type: string
  761. paths:
  762. description: id路径
  763. type: string
  764. permission:
  765. description: 权限编码
  766. type: string
  767. sort:
  768. description: 排序
  769. type: integer
  770. sysApi:
  771. items:
  772. $ref: '#/definitions/models.SysApi'
  773. type: array
  774. title:
  775. description: 显示名称
  776. type: string
  777. updateBy:
  778. type: integer
  779. visible:
  780. description: 是否显示
  781. type: string
  782. type: object
  783. dto.SysOperaLogDeleteReq:
  784. properties:
  785. ids:
  786. items:
  787. type: integer
  788. type: array
  789. type: object
  790. dto.SysPostDeleteReq:
  791. properties:
  792. createBy:
  793. type: integer
  794. ids:
  795. items:
  796. type: integer
  797. type: array
  798. updateBy:
  799. type: integer
  800. type: object
  801. dto.SysPostInsertReq:
  802. properties:
  803. createBy:
  804. type: integer
  805. postCode:
  806. type: string
  807. postId:
  808. type: integer
  809. postName:
  810. type: string
  811. remark:
  812. type: string
  813. sort:
  814. type: integer
  815. status:
  816. type: integer
  817. updateBy:
  818. type: integer
  819. type: object
  820. dto.SysPostUpdateReq:
  821. properties:
  822. createBy:
  823. type: integer
  824. postCode:
  825. type: string
  826. postId:
  827. type: integer
  828. postName:
  829. type: string
  830. remark:
  831. type: string
  832. sort:
  833. type: integer
  834. status:
  835. type: integer
  836. updateBy:
  837. type: integer
  838. type: object
  839. dto.SysRoleDeleteReq:
  840. properties:
  841. ids:
  842. items:
  843. type: integer
  844. type: array
  845. type: object
  846. dto.SysRoleInsertReq:
  847. properties:
  848. admin:
  849. type: boolean
  850. createBy:
  851. type: integer
  852. dataScope:
  853. type: string
  854. deptIds:
  855. items:
  856. type: integer
  857. type: array
  858. flag:
  859. description: 标记
  860. type: string
  861. menuIds:
  862. items:
  863. type: integer
  864. type: array
  865. remark:
  866. description: 备注
  867. type: string
  868. roleId:
  869. description: 角色编码
  870. type: integer
  871. roleKey:
  872. description: 角色代码
  873. type: string
  874. roleName:
  875. description: 角色名称
  876. type: string
  877. roleSort:
  878. description: 角色排序
  879. type: integer
  880. status:
  881. description: 状态
  882. type: string
  883. sysDept:
  884. items:
  885. $ref: '#/definitions/models.SysDept'
  886. type: array
  887. sysMenu:
  888. items:
  889. $ref: '#/definitions/models.SysMenu'
  890. type: array
  891. updateBy:
  892. type: integer
  893. type: object
  894. dto.SysRoleUpdateReq:
  895. properties:
  896. admin:
  897. type: boolean
  898. createBy:
  899. type: integer
  900. dataScope:
  901. type: string
  902. deptIds:
  903. items:
  904. type: integer
  905. type: array
  906. flag:
  907. description: 标记
  908. type: string
  909. menuIds:
  910. items:
  911. type: integer
  912. type: array
  913. remark:
  914. description: 备注
  915. type: string
  916. roleId:
  917. description: 角色编码
  918. type: integer
  919. roleKey:
  920. description: 角色代码
  921. type: string
  922. roleName:
  923. description: 角色名称
  924. type: string
  925. roleSort:
  926. description: 角色排序
  927. type: integer
  928. status:
  929. description: 状态
  930. type: string
  931. sysDept:
  932. items:
  933. $ref: '#/definitions/models.SysDept'
  934. type: array
  935. sysMenu:
  936. items:
  937. $ref: '#/definitions/models.SysMenu'
  938. type: array
  939. updateBy:
  940. type: integer
  941. type: object
  942. dto.SysUserInsertReq:
  943. properties:
  944. avatar:
  945. type: string
  946. createBy:
  947. type: integer
  948. deptId:
  949. type: integer
  950. email:
  951. type: string
  952. nickName:
  953. type: string
  954. password:
  955. type: string
  956. phone:
  957. type: string
  958. postId:
  959. type: integer
  960. remark:
  961. type: string
  962. roleId:
  963. type: integer
  964. sex:
  965. type: string
  966. status:
  967. default: "1"
  968. type: string
  969. updateBy:
  970. type: integer
  971. userId:
  972. description: 用户ID
  973. type: integer
  974. username:
  975. type: string
  976. type: object
  977. dto.SysUserUpdateReq:
  978. properties:
  979. avatar:
  980. type: string
  981. createBy:
  982. type: integer
  983. deptId:
  984. type: integer
  985. email:
  986. type: string
  987. nickName:
  988. type: string
  989. phone:
  990. type: string
  991. postId:
  992. type: integer
  993. remark:
  994. type: string
  995. roleId:
  996. type: integer
  997. sex:
  998. type: string
  999. status:
  1000. default: "1"
  1001. type: string
  1002. updateBy:
  1003. type: integer
  1004. userId:
  1005. description: 用户ID
  1006. type: integer
  1007. username:
  1008. type: string
  1009. type: object
  1010. dto.UpdateStatusReq:
  1011. properties:
  1012. createBy:
  1013. type: integer
  1014. roleId:
  1015. description: 角色编码
  1016. type: integer
  1017. status:
  1018. description: 状态
  1019. type: string
  1020. updateBy:
  1021. type: integer
  1022. type: object
  1023. dto.UpdateSysUserStatusReq:
  1024. properties:
  1025. createBy:
  1026. type: integer
  1027. status:
  1028. type: string
  1029. updateBy:
  1030. type: integer
  1031. userId:
  1032. description: 用户ID
  1033. type: integer
  1034. type: object
  1035. handler.Login:
  1036. properties:
  1037. code:
  1038. type: string
  1039. password:
  1040. type: string
  1041. username:
  1042. type: string
  1043. uuid:
  1044. type: string
  1045. required:
  1046. - code
  1047. - password
  1048. - username
  1049. - uuid
  1050. type: object
  1051. models.SysApi:
  1052. properties:
  1053. action:
  1054. type: string
  1055. createBy:
  1056. type: integer
  1057. createdAt:
  1058. type: string
  1059. handle:
  1060. type: string
  1061. id:
  1062. type: integer
  1063. path:
  1064. type: string
  1065. title:
  1066. type: string
  1067. type:
  1068. type: string
  1069. updateBy:
  1070. type: integer
  1071. updatedAt:
  1072. type: string
  1073. type: object
  1074. models.SysConfig:
  1075. properties:
  1076. configKey:
  1077. type: string
  1078. configName:
  1079. type: string
  1080. configType:
  1081. type: string
  1082. configValue:
  1083. type: string
  1084. createBy:
  1085. type: integer
  1086. createdAt:
  1087. type: string
  1088. id:
  1089. type: integer
  1090. isFrontend:
  1091. type: integer
  1092. remark:
  1093. type: string
  1094. updateBy:
  1095. type: integer
  1096. updatedAt:
  1097. type: string
  1098. type: object
  1099. models.SysDept:
  1100. properties:
  1101. children:
  1102. items:
  1103. $ref: '#/definitions/models.SysDept'
  1104. type: array
  1105. createBy:
  1106. type: integer
  1107. createdAt:
  1108. type: string
  1109. dataScope:
  1110. type: string
  1111. deptId:
  1112. description: 部门编码
  1113. type: integer
  1114. deptName:
  1115. description: 部门名称
  1116. type: string
  1117. deptPath:
  1118. type: string
  1119. email:
  1120. description: 邮箱
  1121. type: string
  1122. leader:
  1123. description: 负责人
  1124. type: string
  1125. params:
  1126. type: string
  1127. parentId:
  1128. description: 上级部门
  1129. type: integer
  1130. phone:
  1131. description: 手机
  1132. type: string
  1133. sort:
  1134. description: 排序
  1135. type: integer
  1136. status:
  1137. description: 状态
  1138. type: integer
  1139. updateBy:
  1140. type: integer
  1141. updatedAt:
  1142. type: string
  1143. type: object
  1144. models.SysMenu:
  1145. properties:
  1146. action:
  1147. type: string
  1148. apis:
  1149. items:
  1150. type: integer
  1151. type: array
  1152. breadcrumb:
  1153. type: string
  1154. children:
  1155. items:
  1156. $ref: '#/definitions/models.SysMenu'
  1157. type: array
  1158. component:
  1159. type: string
  1160. createBy:
  1161. type: integer
  1162. createdAt:
  1163. type: string
  1164. dataScope:
  1165. type: string
  1166. icon:
  1167. type: string
  1168. is_select:
  1169. type: boolean
  1170. isFrame:
  1171. type: string
  1172. menuId:
  1173. type: integer
  1174. menuName:
  1175. type: string
  1176. menuType:
  1177. type: string
  1178. noCache:
  1179. type: boolean
  1180. params:
  1181. type: string
  1182. parentId:
  1183. type: integer
  1184. path:
  1185. type: string
  1186. paths:
  1187. type: string
  1188. permission:
  1189. type: string
  1190. roleId:
  1191. type: integer
  1192. sort:
  1193. type: integer
  1194. sysApi:
  1195. items:
  1196. $ref: '#/definitions/models.SysApi'
  1197. type: array
  1198. title:
  1199. type: string
  1200. updateBy:
  1201. type: integer
  1202. updatedAt:
  1203. type: string
  1204. visible:
  1205. type: string
  1206. type: object
  1207. response.Page:
  1208. properties:
  1209. count:
  1210. type: integer
  1211. pageIndex:
  1212. type: integer
  1213. pageSize:
  1214. type: integer
  1215. type: object
  1216. response.Response:
  1217. properties:
  1218. code:
  1219. type: integer
  1220. msg:
  1221. type: string
  1222. requestId:
  1223. description: 数据集
  1224. type: string
  1225. status:
  1226. type: string
  1227. type: object
  1228. tools.Params:
  1229. properties:
  1230. treeCode:
  1231. type: string
  1232. treeName:
  1233. type: string
  1234. treeParentCode:
  1235. type: string
  1236. type: object
  1237. tools.SysColumns:
  1238. properties:
  1239. columnComment:
  1240. type: string
  1241. columnId:
  1242. type: integer
  1243. columnName:
  1244. type: string
  1245. columnType:
  1246. type: string
  1247. createBy:
  1248. type: integer
  1249. createdAt:
  1250. type: string
  1251. deletedAt:
  1252. type: string
  1253. dictType:
  1254. type: string
  1255. edit:
  1256. type: boolean
  1257. fkCol:
  1258. items:
  1259. $ref: '#/definitions/tools.SysColumns'
  1260. type: array
  1261. fkLabelId:
  1262. type: string
  1263. fkLabelName:
  1264. type: string
  1265. fkTableName:
  1266. type: string
  1267. fkTableNameClass:
  1268. type: string
  1269. fkTableNamePackage:
  1270. type: string
  1271. goField:
  1272. type: string
  1273. goType:
  1274. type: string
  1275. htmlType:
  1276. type: string
  1277. increment:
  1278. type: boolean
  1279. insert:
  1280. type: boolean
  1281. isEdit:
  1282. type: string
  1283. isIncrement:
  1284. type: string
  1285. isInsert:
  1286. type: string
  1287. isList:
  1288. type: string
  1289. isPk:
  1290. type: string
  1291. isQuery:
  1292. type: string
  1293. isRequired:
  1294. type: string
  1295. jsonField:
  1296. type: string
  1297. list:
  1298. type: string
  1299. pk:
  1300. type: boolean
  1301. query:
  1302. type: boolean
  1303. queryType:
  1304. type: string
  1305. remark:
  1306. type: string
  1307. required:
  1308. type: boolean
  1309. sort:
  1310. type: integer
  1311. superColumn:
  1312. type: boolean
  1313. tableId:
  1314. type: integer
  1315. updateBy:
  1316. type: integer
  1317. updatedAt:
  1318. type: string
  1319. usableColumn:
  1320. type: boolean
  1321. type: object
  1322. tools.SysTables:
  1323. properties:
  1324. businessName:
  1325. type: string
  1326. className:
  1327. description: 类名
  1328. type: string
  1329. columns:
  1330. items:
  1331. $ref: '#/definitions/tools.SysColumns'
  1332. type: array
  1333. createBy:
  1334. type: integer
  1335. createdAt:
  1336. type: string
  1337. crud:
  1338. type: boolean
  1339. dataScope:
  1340. type: string
  1341. deletedAt:
  1342. type: string
  1343. functionAuthor:
  1344. description: 功能作者
  1345. type: string
  1346. functionName:
  1347. description: 功能名称
  1348. type: string
  1349. isActions:
  1350. type: integer
  1351. isAuth:
  1352. type: integer
  1353. isDataScope:
  1354. type: integer
  1355. isLogicalDelete:
  1356. type: string
  1357. logicalDelete:
  1358. type: boolean
  1359. logicalDeleteColumn:
  1360. type: string
  1361. moduleFrontName:
  1362. description: 前端文件名
  1363. type: string
  1364. moduleName:
  1365. description: go文件名
  1366. type: string
  1367. options:
  1368. type: string
  1369. packageName:
  1370. description: 包名
  1371. type: string
  1372. params:
  1373. $ref: '#/definitions/tools.Params'
  1374. pkColumn:
  1375. type: string
  1376. pkGoField:
  1377. type: string
  1378. pkJsonField:
  1379. type: string
  1380. remark:
  1381. type: string
  1382. tableComment:
  1383. description: 表备注
  1384. type: string
  1385. tableId:
  1386. description: 表编码
  1387. type: integer
  1388. tableName:
  1389. description: 表名称
  1390. type: string
  1391. tplCategory:
  1392. type: string
  1393. tree:
  1394. type: boolean
  1395. treeCode:
  1396. type: string
  1397. treeName:
  1398. type: string
  1399. treeParentCode:
  1400. type: string
  1401. updateBy:
  1402. type: integer
  1403. updatedAt:
  1404. type: string
  1405. type: object
  1406. info:
  1407. contact: {}
  1408. description: |-
  1409. 基于Gin + Vue + Element UI的前后端分离权限管理系统的接口文档
  1410. 添加qq群: 521386980 进入技术交流群 请先star,谢谢!
  1411. license:
  1412. name: MIT
  1413. url: https://github.com/go-admin-team/go-admin/blob/master/LICENSE.md
  1414. title: go-admin API
  1415. version: 2.0.0
  1416. paths:
  1417. /api/v1/app-config:
  1418. get:
  1419. description: 获取系统配置信息,主要注意这里不在验证权限
  1420. responses:
  1421. "200":
  1422. description: '{"code": 200, "data": [...]}'
  1423. schema:
  1424. allOf:
  1425. - $ref: '#/definitions/response.Response'
  1426. - properties:
  1427. data:
  1428. additionalProperties:
  1429. type: string
  1430. type: object
  1431. type: object
  1432. summary: 获取系统前台配置信息,主要注意这里不在验证权限
  1433. tags:
  1434. - 配置管理
  1435. /api/v1/captcha:
  1436. get:
  1437. description: 获取验证码
  1438. responses:
  1439. "200":
  1440. description: '{"code": 200, "data": [...]}'
  1441. schema:
  1442. allOf:
  1443. - $ref: '#/definitions/response.Response'
  1444. - properties:
  1445. data:
  1446. type: string
  1447. id:
  1448. type: string
  1449. msg:
  1450. type: string
  1451. type: object
  1452. summary: 获取验证码
  1453. tags:
  1454. - 登陆
  1455. /api/v1/db/columns/page:
  1456. get:
  1457. description: 数据库表列分页列表 / database table column page list
  1458. parameters:
  1459. - description: tableName / 数据表名称
  1460. in: query
  1461. name: tableName
  1462. type: string
  1463. - description: pageSize / 页条数
  1464. in: query
  1465. name: pageSize
  1466. type: integer
  1467. - description: pageIndex / 页码
  1468. in: query
  1469. name: pageIndex
  1470. type: integer
  1471. responses:
  1472. "200":
  1473. description: '{"code": 200, "data": [...]}'
  1474. schema:
  1475. $ref: '#/definitions/response.Response'
  1476. summary: 分页列表数据 / page list data
  1477. tags:
  1478. - 工具 / 生成工具
  1479. /api/v1/db/tables/page:
  1480. get:
  1481. description: 数据库表分页列表 / database table page list
  1482. parameters:
  1483. - description: tableName / 数据表名称
  1484. in: query
  1485. name: tableName
  1486. type: string
  1487. - description: pageSize / 页条数
  1488. in: query
  1489. name: pageSize
  1490. type: integer
  1491. - description: pageIndex / 页码
  1492. in: query
  1493. name: pageIndex
  1494. type: integer
  1495. responses:
  1496. "200":
  1497. description: '{"code": 200, "data": [...]}'
  1498. schema:
  1499. $ref: '#/definitions/response.Response'
  1500. summary: 分页列表数据 / page list data
  1501. tags:
  1502. - 工具 / 生成工具
  1503. /api/v1/dept:
  1504. delete:
  1505. description: 删除数据
  1506. parameters:
  1507. - description: body
  1508. in: body
  1509. name: data
  1510. required: true
  1511. schema:
  1512. $ref: '#/definitions/dto.SysDeptDeleteReq'
  1513. responses:
  1514. "200":
  1515. description: '{"code": -1, "message": "删除失败"}'
  1516. schema:
  1517. type: string
  1518. security:
  1519. - Bearer: []
  1520. summary: 删除部门
  1521. tags:
  1522. - 部门
  1523. get:
  1524. description: 分页列表
  1525. parameters:
  1526. - description: deptName
  1527. in: query
  1528. name: deptName
  1529. type: string
  1530. - description: deptId
  1531. in: query
  1532. name: deptId
  1533. type: string
  1534. - description: position
  1535. in: query
  1536. name: position
  1537. type: string
  1538. responses:
  1539. "200":
  1540. description: '{"code": 200, "data": [...]}'
  1541. schema:
  1542. $ref: '#/definitions/response.Response'
  1543. security:
  1544. - Bearer: []
  1545. summary: 分页部门列表数据
  1546. tags:
  1547. - 部门
  1548. post:
  1549. consumes:
  1550. - application/json
  1551. description: 获取JSON
  1552. parameters:
  1553. - description: data
  1554. in: body
  1555. name: data
  1556. required: true
  1557. schema:
  1558. $ref: '#/definitions/dto.SysDeptInsertReq'
  1559. responses:
  1560. "200":
  1561. description: '{"code": -1, "message": "添加失败"}'
  1562. schema:
  1563. type: string
  1564. security:
  1565. - Bearer: []
  1566. summary: 添加部门
  1567. tags:
  1568. - 部门
  1569. /api/v1/dept/{deptId}:
  1570. get:
  1571. description: 获取JSON
  1572. parameters:
  1573. - description: deptId
  1574. in: path
  1575. name: deptId
  1576. type: string
  1577. responses:
  1578. "200":
  1579. description: '{"code": 200, "data": [...]}'
  1580. schema:
  1581. $ref: '#/definitions/response.Response'
  1582. security:
  1583. - Bearer: []
  1584. summary: 获取部门数据
  1585. tags:
  1586. - 部门
  1587. put:
  1588. consumes:
  1589. - application/json
  1590. description: 获取JSON
  1591. parameters:
  1592. - description: id
  1593. in: path
  1594. name: id
  1595. required: true
  1596. type: integer
  1597. - description: body
  1598. in: body
  1599. name: data
  1600. required: true
  1601. schema:
  1602. $ref: '#/definitions/dto.SysDeptUpdateReq'
  1603. responses:
  1604. "200":
  1605. description: '{"code": -1, "message": "添加失败"}'
  1606. schema:
  1607. type: string
  1608. security:
  1609. - Bearer: []
  1610. summary: 修改部门
  1611. tags:
  1612. - 部门
  1613. /api/v1/dict-data/option-select:
  1614. get:
  1615. description: 数据字典根据key获取
  1616. parameters:
  1617. - description: dictType
  1618. in: query
  1619. name: dictType
  1620. required: true
  1621. type: integer
  1622. responses:
  1623. "200":
  1624. description: '{"code": 200, "data": [...]}'
  1625. schema:
  1626. allOf:
  1627. - $ref: '#/definitions/response.Response'
  1628. - properties:
  1629. data:
  1630. items:
  1631. $ref: '#/definitions/dto.SysDictDataGetAllResp'
  1632. type: array
  1633. type: object
  1634. security:
  1635. - Bearer: []
  1636. summary: 数据字典根据key获取
  1637. tags:
  1638. - 字典数据
  1639. /api/v1/dict/data:
  1640. delete:
  1641. description: 删除数据
  1642. parameters:
  1643. - description: body
  1644. in: body
  1645. name: dictCode
  1646. required: true
  1647. schema:
  1648. $ref: '#/definitions/dto.SysDictDataDeleteReq'
  1649. responses:
  1650. "200":
  1651. description: '{"code": 200, "message": "删除成功"}'
  1652. schema:
  1653. $ref: '#/definitions/response.Response'
  1654. security:
  1655. - Bearer: []
  1656. summary: 删除字典数据
  1657. tags:
  1658. - 字典数据
  1659. get:
  1660. description: 获取JSON
  1661. parameters:
  1662. - description: status
  1663. in: query
  1664. name: status
  1665. type: string
  1666. - description: dictCode
  1667. in: query
  1668. name: dictCode
  1669. type: string
  1670. - description: dictType
  1671. in: query
  1672. name: dictType
  1673. type: string
  1674. - description: 页条数
  1675. in: query
  1676. name: pageSize
  1677. type: integer
  1678. - description: 页码
  1679. in: query
  1680. name: pageIndex
  1681. type: integer
  1682. responses:
  1683. "200":
  1684. description: '{"code": 200, "data": [...]}'
  1685. schema:
  1686. $ref: '#/definitions/response.Response'
  1687. security:
  1688. - Bearer: []
  1689. summary: 字典数据列表
  1690. tags:
  1691. - 字典数据
  1692. post:
  1693. consumes:
  1694. - application/json
  1695. description: 获取JSON
  1696. parameters:
  1697. - description: data
  1698. in: body
  1699. name: data
  1700. required: true
  1701. schema:
  1702. $ref: '#/definitions/dto.SysDictDataInsertReq'
  1703. responses:
  1704. "200":
  1705. description: '{"code": 200, "message": "添加成功"}'
  1706. schema:
  1707. $ref: '#/definitions/response.Response'
  1708. security:
  1709. - Bearer: []
  1710. summary: 添加字典数据
  1711. tags:
  1712. - 字典数据
  1713. /api/v1/dict/data/{dictCode}:
  1714. get:
  1715. description: 获取JSON
  1716. parameters:
  1717. - description: 字典编码
  1718. in: path
  1719. name: dictCode
  1720. required: true
  1721. type: integer
  1722. responses:
  1723. "200":
  1724. description: '{"code": 200, "data": [...]}'
  1725. schema:
  1726. $ref: '#/definitions/response.Response'
  1727. security:
  1728. - Bearer: []
  1729. summary: 通过编码获取字典数据
  1730. tags:
  1731. - 字典数据
  1732. put:
  1733. consumes:
  1734. - application/json
  1735. description: 获取JSON
  1736. parameters:
  1737. - description: body
  1738. in: body
  1739. name: data
  1740. required: true
  1741. schema:
  1742. $ref: '#/definitions/dto.SysDictDataUpdateReq'
  1743. responses:
  1744. "200":
  1745. description: '{"code": 200, "message": "修改成功"}'
  1746. schema:
  1747. $ref: '#/definitions/response.Response'
  1748. security:
  1749. - Bearer: []
  1750. summary: 修改字典数据
  1751. tags:
  1752. - 字典数据
  1753. /api/v1/dict/type:
  1754. delete:
  1755. description: 删除数据
  1756. parameters:
  1757. - description: body
  1758. in: body
  1759. name: dictCode
  1760. required: true
  1761. schema:
  1762. $ref: '#/definitions/dto.SysDictTypeDeleteReq'
  1763. responses:
  1764. "200":
  1765. description: '{"code": 200, "data": [...]}'
  1766. schema:
  1767. $ref: '#/definitions/response.Response'
  1768. security:
  1769. - Bearer: []
  1770. summary: 删除字典类型
  1771. tags:
  1772. - 字典类型
  1773. get:
  1774. description: 获取JSON
  1775. parameters:
  1776. - description: dictName
  1777. in: query
  1778. name: dictName
  1779. type: string
  1780. - description: dictId
  1781. in: query
  1782. name: dictId
  1783. type: string
  1784. - description: dictType
  1785. in: query
  1786. name: dictType
  1787. type: string
  1788. - description: 页条数
  1789. in: query
  1790. name: pageSize
  1791. type: integer
  1792. - description: 页码
  1793. in: query
  1794. name: pageIndex
  1795. type: integer
  1796. responses:
  1797. "200":
  1798. description: '{"code": 200, "data": [...]}'
  1799. schema:
  1800. $ref: '#/definitions/response.Response'
  1801. security:
  1802. - Bearer: []
  1803. summary: 字典类型列表数据
  1804. tags:
  1805. - 字典类型
  1806. post:
  1807. consumes:
  1808. - application/json
  1809. description: 获取JSON
  1810. parameters:
  1811. - description: data
  1812. in: body
  1813. name: data
  1814. required: true
  1815. schema:
  1816. $ref: '#/definitions/dto.SysDictTypeInsertReq'
  1817. responses:
  1818. "200":
  1819. description: '{"code": 200, "data": [...]}'
  1820. schema:
  1821. $ref: '#/definitions/response.Response'
  1822. security:
  1823. - Bearer: []
  1824. summary: 添加字典类型
  1825. tags:
  1826. - 字典类型
  1827. /api/v1/dict/type-option-select:
  1828. get:
  1829. description: 获取JSON
  1830. parameters:
  1831. - description: dictName
  1832. in: query
  1833. name: dictName
  1834. type: string
  1835. - description: dictId
  1836. in: query
  1837. name: dictId
  1838. type: string
  1839. - description: dictType
  1840. in: query
  1841. name: dictType
  1842. type: string
  1843. responses:
  1844. "200":
  1845. description: '{"code": 200, "data": [...]}'
  1846. schema:
  1847. $ref: '#/definitions/response.Response'
  1848. security:
  1849. - Bearer: []
  1850. summary: 字典类型全部数据 代码生成使用接口
  1851. tags:
  1852. - 字典类型
  1853. /api/v1/dict/type/{dictId}:
  1854. get:
  1855. description: 获取JSON
  1856. parameters:
  1857. - description: 字典类型编码
  1858. in: path
  1859. name: dictId
  1860. required: true
  1861. type: integer
  1862. responses:
  1863. "200":
  1864. description: '{"code": 200, "data": [...]}'
  1865. schema:
  1866. $ref: '#/definitions/response.Response'
  1867. security:
  1868. - Bearer: []
  1869. summary: 字典类型通过字典id获取
  1870. tags:
  1871. - 字典类型
  1872. put:
  1873. consumes:
  1874. - application/json
  1875. description: 获取JSON
  1876. parameters:
  1877. - description: body
  1878. in: body
  1879. name: data
  1880. required: true
  1881. schema:
  1882. $ref: '#/definitions/dto.SysDictTypeUpdateReq'
  1883. responses:
  1884. "200":
  1885. description: '{"code": 200, "data": [...]}'
  1886. schema:
  1887. $ref: '#/definitions/response.Response'
  1888. security:
  1889. - Bearer: []
  1890. summary: 修改字典类型
  1891. tags:
  1892. - 字典类型
  1893. /api/v1/getinfo:
  1894. get:
  1895. description: 获取JSON
  1896. responses:
  1897. "200":
  1898. description: '{"code": 200, "data": [...]}'
  1899. schema:
  1900. $ref: '#/definitions/response.Response'
  1901. security:
  1902. - Bearer: []
  1903. summary: 获取个人信息
  1904. tags:
  1905. - 个人中心
  1906. /api/v1/login:
  1907. post:
  1908. consumes:
  1909. - application/json
  1910. description: |-
  1911. 获取token
  1912. LoginHandler can be used by clients to get a jwt token.
  1913. Payload needs to be json in the form of {"username": "USERNAME", "password": "PASSWORD"}.
  1914. Reply will be of the form {"token": "TOKEN"}.
  1915. dev mode:It should be noted that all fields cannot be empty, and a value of 0 can be passed in addition to the account password
  1916. 注意:开发模式:需要注意全部字段不能为空,账号密码外可以传入0值
  1917. parameters:
  1918. - description: account
  1919. in: body
  1920. name: account
  1921. required: true
  1922. schema:
  1923. $ref: '#/definitions/handler.Login'
  1924. responses:
  1925. "200":
  1926. description: '{"code": 200, "expire": "2019-08-07T12:45:48+08:00", "token":
  1927. ".eyJleHAiOjE1NjUxNTMxNDgsImlkIjoiYWRtaW4iLCJvcmlnX2lhdCI6MTU2NTE0OTU0OH0.-zvzHvbg0A"
  1928. }'
  1929. schema:
  1930. type: string
  1931. summary: 登陆
  1932. tags:
  1933. - 登陆
  1934. /api/v1/menu:
  1935. delete:
  1936. description: 删除数据
  1937. parameters:
  1938. - description: body
  1939. in: body
  1940. name: data
  1941. required: true
  1942. schema:
  1943. $ref: '#/definitions/dto.SysMenuDeleteReq'
  1944. responses:
  1945. "200":
  1946. description: '{"code": 200, "data": [...]}'
  1947. schema:
  1948. $ref: '#/definitions/response.Response'
  1949. security:
  1950. - Bearer: []
  1951. summary: 删除菜单
  1952. tags:
  1953. - 菜单
  1954. get:
  1955. description: 获取JSON
  1956. parameters:
  1957. - description: menuName
  1958. in: query
  1959. name: menuName
  1960. type: string
  1961. responses:
  1962. "200":
  1963. description: '{"code": 200, "data": [...]}'
  1964. schema:
  1965. $ref: '#/definitions/response.Response'
  1966. security:
  1967. - Bearer: []
  1968. summary: Menu列表数据
  1969. tags:
  1970. - 菜单
  1971. post:
  1972. consumes:
  1973. - application/json
  1974. description: 获取JSON
  1975. parameters:
  1976. - description: data
  1977. in: body
  1978. name: data
  1979. required: true
  1980. schema:
  1981. $ref: '#/definitions/dto.SysMenuInsertReq'
  1982. responses:
  1983. "200":
  1984. description: '{"code": 200, "data": [...]}'
  1985. schema:
  1986. $ref: '#/definitions/response.Response'
  1987. security:
  1988. - Bearer: []
  1989. summary: 创建菜单
  1990. tags:
  1991. - 菜单
  1992. /api/v1/menu/{id}:
  1993. get:
  1994. description: 获取JSON
  1995. parameters:
  1996. - description: id
  1997. in: path
  1998. name: id
  1999. type: string
  2000. responses:
  2001. "200":
  2002. description: '{"code": 200, "data": [...]}'
  2003. schema:
  2004. $ref: '#/definitions/response.Response'
  2005. security:
  2006. - Bearer: []
  2007. summary: Menu详情数据
  2008. tags:
  2009. - 菜单
  2010. put:
  2011. consumes:
  2012. - application/json
  2013. description: 获取JSON
  2014. parameters:
  2015. - description: id
  2016. in: path
  2017. name: id
  2018. required: true
  2019. type: integer
  2020. - description: body
  2021. in: body
  2022. name: data
  2023. required: true
  2024. schema:
  2025. $ref: '#/definitions/dto.SysMenuUpdateReq'
  2026. responses:
  2027. "200":
  2028. description: '{"code": 200, "data": [...]}'
  2029. schema:
  2030. $ref: '#/definitions/response.Response'
  2031. security:
  2032. - Bearer: []
  2033. summary: 修改菜单
  2034. tags:
  2035. - 菜单
  2036. /api/v1/menuTreeselect/{roleId}:
  2037. get:
  2038. consumes:
  2039. - application/json
  2040. description: 获取JSON
  2041. parameters:
  2042. - description: roleId
  2043. in: path
  2044. name: roleId
  2045. required: true
  2046. type: integer
  2047. responses:
  2048. "200":
  2049. description: '{"code": 200, "data": [...]}'
  2050. schema:
  2051. $ref: '#/definitions/response.Response'
  2052. security:
  2053. - Bearer: []
  2054. summary: 角色修改使用的菜单列表
  2055. tags:
  2056. - 菜单
  2057. /api/v1/menurole:
  2058. get:
  2059. description: 获取JSON
  2060. responses:
  2061. "200":
  2062. description: '{"code": 200, "data": [...]}'
  2063. schema:
  2064. $ref: '#/definitions/response.Response'
  2065. security:
  2066. - Bearer: []
  2067. summary: 根据登录角色名称获取菜单列表数据(左菜单使用)
  2068. tags:
  2069. - 菜单
  2070. /api/v1/post:
  2071. delete:
  2072. description: 删除数据
  2073. parameters:
  2074. - description: 请求参数
  2075. in: body
  2076. name: id
  2077. required: true
  2078. schema:
  2079. $ref: '#/definitions/dto.SysPostDeleteReq'
  2080. responses:
  2081. "200":
  2082. description: '{"code": 200, "data": [...]}'
  2083. schema:
  2084. $ref: '#/definitions/response.Response'
  2085. security:
  2086. - Bearer: []
  2087. summary: 删除岗位
  2088. tags:
  2089. - 岗位
  2090. get:
  2091. description: 获取JSON
  2092. parameters:
  2093. - description: postName
  2094. in: query
  2095. name: postName
  2096. type: string
  2097. - description: postCode
  2098. in: query
  2099. name: postCode
  2100. type: string
  2101. - description: postId
  2102. in: query
  2103. name: postId
  2104. type: string
  2105. - description: status
  2106. in: query
  2107. name: status
  2108. type: string
  2109. responses:
  2110. "200":
  2111. description: '{"code": 200, "data": [...]}'
  2112. schema:
  2113. $ref: '#/definitions/response.Response'
  2114. security:
  2115. - Bearer: []
  2116. summary: 岗位列表数据
  2117. tags:
  2118. - 岗位
  2119. post:
  2120. consumes:
  2121. - application/json
  2122. description: 获取JSON
  2123. parameters:
  2124. - description: data
  2125. in: body
  2126. name: data
  2127. required: true
  2128. schema:
  2129. $ref: '#/definitions/dto.SysPostInsertReq'
  2130. responses:
  2131. "200":
  2132. description: '{"code": 200, "data": [...]}'
  2133. schema:
  2134. $ref: '#/definitions/response.Response'
  2135. security:
  2136. - Bearer: []
  2137. summary: 添加岗位
  2138. tags:
  2139. - 岗位
  2140. /api/v1/post/{id}:
  2141. put:
  2142. consumes:
  2143. - application/json
  2144. description: 获取JSON
  2145. parameters:
  2146. - description: body
  2147. in: body
  2148. name: data
  2149. required: true
  2150. schema:
  2151. $ref: '#/definitions/dto.SysPostUpdateReq'
  2152. responses:
  2153. "200":
  2154. description: '{"code": 200, "data": [...]}'
  2155. schema:
  2156. $ref: '#/definitions/response.Response'
  2157. security:
  2158. - Bearer: []
  2159. summary: 修改岗位
  2160. tags:
  2161. - 岗位
  2162. /api/v1/post/{postId}:
  2163. get:
  2164. description: 获取JSON
  2165. parameters:
  2166. - description: 编码
  2167. in: path
  2168. name: id
  2169. required: true
  2170. type: integer
  2171. responses:
  2172. "200":
  2173. description: '{"code": 200, "data": [...]}'
  2174. schema:
  2175. $ref: '#/definitions/response.Response'
  2176. security:
  2177. - Bearer: []
  2178. summary: 获取岗位信息
  2179. tags:
  2180. - 岗位
  2181. /api/v1/public/uploadFile:
  2182. post:
  2183. consumes:
  2184. - multipart/form-data
  2185. description: 获取JSON
  2186. parameters:
  2187. - description: type
  2188. in: query
  2189. name: type
  2190. required: true
  2191. type: string
  2192. - description: file
  2193. in: formData
  2194. name: file
  2195. required: true
  2196. type: file
  2197. responses:
  2198. "200":
  2199. description: '{"code": -1, "message": "添加失败"}'
  2200. schema:
  2201. type: string
  2202. security:
  2203. - Bearer: []
  2204. summary: 上传图片
  2205. tags:
  2206. - 公共接口
  2207. /api/v1/role:
  2208. delete:
  2209. description: 删除数据
  2210. parameters:
  2211. - description: body
  2212. in: body
  2213. name: data
  2214. required: true
  2215. schema:
  2216. $ref: '#/definitions/dto.SysRoleDeleteReq'
  2217. responses:
  2218. "200":
  2219. description: '{"code": 200, "data": [...]}'
  2220. schema:
  2221. $ref: '#/definitions/response.Response'
  2222. security:
  2223. - Bearer: []
  2224. summary: 删除用户角色
  2225. tags:
  2226. - 角色/Role
  2227. get:
  2228. description: Get JSON
  2229. parameters:
  2230. - description: roleName
  2231. in: query
  2232. name: roleName
  2233. type: string
  2234. - description: status
  2235. in: query
  2236. name: status
  2237. type: string
  2238. - description: roleKey
  2239. in: query
  2240. name: roleKey
  2241. type: string
  2242. - description: 页条数
  2243. in: query
  2244. name: pageSize
  2245. type: integer
  2246. - description: 页码
  2247. in: query
  2248. name: pageIndex
  2249. type: integer
  2250. responses:
  2251. "200":
  2252. description: '{"code": 200, "data": [...]}'
  2253. schema:
  2254. $ref: '#/definitions/response.Response'
  2255. security:
  2256. - Bearer: []
  2257. summary: 角色列表数据
  2258. tags:
  2259. - 角色/Role
  2260. post:
  2261. consumes:
  2262. - application/json
  2263. description: 获取JSON
  2264. parameters:
  2265. - description: data
  2266. in: body
  2267. name: data
  2268. required: true
  2269. schema:
  2270. $ref: '#/definitions/dto.SysRoleInsertReq'
  2271. responses:
  2272. "200":
  2273. description: '{"code": 200, "data": [...]}'
  2274. schema:
  2275. $ref: '#/definitions/response.Response'
  2276. security:
  2277. - Bearer: []
  2278. summary: 创建角色
  2279. tags:
  2280. - 角色/Role
  2281. /api/v1/role-status/{id}:
  2282. put:
  2283. consumes:
  2284. - application/json
  2285. description: 获取JSON
  2286. parameters:
  2287. - description: body
  2288. in: body
  2289. name: data
  2290. required: true
  2291. schema:
  2292. $ref: '#/definitions/dto.RoleDataScopeReq'
  2293. responses:
  2294. "200":
  2295. description: '{"code": 200, "data": [...]}'
  2296. schema:
  2297. $ref: '#/definitions/response.Response'
  2298. security:
  2299. - Bearer: []
  2300. summary: 更新角色数据权限
  2301. tags:
  2302. - 角色/Role
  2303. /api/v1/role/{id}:
  2304. get:
  2305. description: 获取JSON
  2306. parameters:
  2307. - description: roleId
  2308. in: path
  2309. name: roleId
  2310. type: string
  2311. responses:
  2312. "200":
  2313. description: '{"code": 200, "data": [...]}'
  2314. schema:
  2315. $ref: '#/definitions/response.Response'
  2316. security:
  2317. - Bearer: []
  2318. summary: 获取Role数据
  2319. tags:
  2320. - 角色/Role
  2321. put:
  2322. consumes:
  2323. - application/json
  2324. description: 获取JSON
  2325. parameters:
  2326. - description: body
  2327. in: body
  2328. name: data
  2329. required: true
  2330. schema:
  2331. $ref: '#/definitions/dto.SysRoleUpdateReq'
  2332. responses:
  2333. "200":
  2334. description: '{"code": 200, "data": [...]}'
  2335. schema:
  2336. $ref: '#/definitions/response.Response'
  2337. security:
  2338. - Bearer: []
  2339. summary: 修改用户角色
  2340. tags:
  2341. - 角色/Role
  2342. /api/v1/server-monitor:
  2343. get:
  2344. description: 获取JSON
  2345. responses:
  2346. "200":
  2347. description: '{"code": 200, "data": [...]}'
  2348. schema:
  2349. $ref: '#/definitions/response.Response'
  2350. security:
  2351. - Bearer: []
  2352. summary: 系统信息
  2353. tags:
  2354. - 系统信息
  2355. /api/v1/set-config:
  2356. get:
  2357. consumes:
  2358. - application/json
  2359. description: 界面操作设置配置值的获取
  2360. responses:
  2361. "200":
  2362. description: '{"code": 200, "message": "修改成功"}'
  2363. schema:
  2364. allOf:
  2365. - $ref: '#/definitions/response.Response'
  2366. - properties:
  2367. data:
  2368. additionalProperties: true
  2369. type: object
  2370. type: object
  2371. security:
  2372. - Bearer: []
  2373. summary: 获取配置
  2374. tags:
  2375. - 配置管理
  2376. put:
  2377. consumes:
  2378. - application/json
  2379. description: 界面操作设置配置值
  2380. parameters:
  2381. - description: body
  2382. in: body
  2383. name: data
  2384. required: true
  2385. schema:
  2386. items:
  2387. $ref: '#/definitions/dto.GetSetSysConfigReq'
  2388. type: array
  2389. responses:
  2390. "200":
  2391. description: '{"code": 200, "message": "修改成功"}'
  2392. schema:
  2393. $ref: '#/definitions/response.Response'
  2394. security:
  2395. - Bearer: []
  2396. summary: 设置配置
  2397. tags:
  2398. - 配置管理
  2399. /api/v1/sys-api:
  2400. delete:
  2401. description: 删除接口管理
  2402. parameters:
  2403. - description: body
  2404. in: body
  2405. name: data
  2406. required: true
  2407. schema:
  2408. $ref: '#/definitions/dto.SysApiDeleteReq'
  2409. responses:
  2410. "200":
  2411. description: '{"code": 200, "message": "删除成功"}'
  2412. schema:
  2413. $ref: '#/definitions/response.Response'
  2414. security:
  2415. - Bearer: []
  2416. summary: 删除接口管理
  2417. tags:
  2418. - 接口管理
  2419. get:
  2420. description: 获取接口管理列表
  2421. parameters:
  2422. - description: 名称
  2423. in: query
  2424. name: name
  2425. type: string
  2426. - description: 标题
  2427. in: query
  2428. name: title
  2429. type: string
  2430. - description: 地址
  2431. in: query
  2432. name: path
  2433. type: string
  2434. - description: 类型
  2435. in: query
  2436. name: action
  2437. type: string
  2438. - description: 页条数
  2439. in: query
  2440. name: pageSize
  2441. type: integer
  2442. - description: 页码
  2443. in: query
  2444. name: pageIndex
  2445. type: integer
  2446. responses:
  2447. "200":
  2448. description: '{"code": 200, "data": [...]}'
  2449. schema:
  2450. allOf:
  2451. - $ref: '#/definitions/response.Response'
  2452. - properties:
  2453. data:
  2454. allOf:
  2455. - $ref: '#/definitions/response.Page'
  2456. - properties:
  2457. list:
  2458. items:
  2459. $ref: '#/definitions/models.SysApi'
  2460. type: array
  2461. type: object
  2462. type: object
  2463. security:
  2464. - Bearer: []
  2465. summary: 获取接口管理列表
  2466. tags:
  2467. - 接口管理
  2468. /api/v1/sys-api/{id}:
  2469. get:
  2470. description: 获取接口管理
  2471. parameters:
  2472. - description: id
  2473. in: path
  2474. name: id
  2475. type: string
  2476. responses:
  2477. "200":
  2478. description: '{"code": 200, "data": [...]}'
  2479. schema:
  2480. allOf:
  2481. - $ref: '#/definitions/response.Response'
  2482. - properties:
  2483. data:
  2484. $ref: '#/definitions/models.SysApi'
  2485. type: object
  2486. security:
  2487. - Bearer: []
  2488. summary: 获取接口管理
  2489. tags:
  2490. - 接口管理
  2491. put:
  2492. consumes:
  2493. - application/json
  2494. description: 修改接口管理
  2495. parameters:
  2496. - description: body
  2497. in: body
  2498. name: data
  2499. required: true
  2500. schema:
  2501. $ref: '#/definitions/dto.SysApiUpdateReq'
  2502. responses:
  2503. "200":
  2504. description: '{"code": 200, "message": "修改成功"}'
  2505. schema:
  2506. $ref: '#/definitions/response.Response'
  2507. security:
  2508. - Bearer: []
  2509. summary: 修改接口管理
  2510. tags:
  2511. - 接口管理
  2512. /api/v1/sys-config:
  2513. delete:
  2514. description: 删除配置管理
  2515. parameters:
  2516. - description: ids
  2517. in: body
  2518. name: ids
  2519. schema:
  2520. items:
  2521. type: integer
  2522. type: array
  2523. responses:
  2524. "200":
  2525. description: '{"code": 200, "message": "删除成功"}'
  2526. schema:
  2527. $ref: '#/definitions/response.Response'
  2528. security:
  2529. - Bearer: []
  2530. summary: 删除配置管理
  2531. tags:
  2532. - 配置管理
  2533. get:
  2534. description: 获取配置管理列表
  2535. parameters:
  2536. - description: 名称
  2537. in: query
  2538. name: configName
  2539. type: string
  2540. - description: key
  2541. in: query
  2542. name: configKey
  2543. type: string
  2544. - description: 类型
  2545. in: query
  2546. name: configType
  2547. type: string
  2548. - description: 是否前端
  2549. in: query
  2550. name: isFrontend
  2551. type: integer
  2552. - description: 页条数
  2553. in: query
  2554. name: pageSize
  2555. type: integer
  2556. - description: 页码
  2557. in: query
  2558. name: pageIndex
  2559. type: integer
  2560. responses:
  2561. "200":
  2562. description: '{"code": 200, "data": [...]}'
  2563. schema:
  2564. allOf:
  2565. - $ref: '#/definitions/response.Response'
  2566. - properties:
  2567. data:
  2568. allOf:
  2569. - $ref: '#/definitions/response.Page'
  2570. - properties:
  2571. list:
  2572. items:
  2573. $ref: '#/definitions/models.SysApi'
  2574. type: array
  2575. type: object
  2576. type: object
  2577. security:
  2578. - Bearer: []
  2579. summary: 获取配置管理列表
  2580. tags:
  2581. - 配置管理
  2582. post:
  2583. consumes:
  2584. - application/json
  2585. description: 创建配置管理
  2586. parameters:
  2587. - description: body
  2588. in: body
  2589. name: data
  2590. required: true
  2591. schema:
  2592. $ref: '#/definitions/dto.SysConfigControl'
  2593. responses:
  2594. "200":
  2595. description: '{"code": 200, "message": "创建成功"}'
  2596. schema:
  2597. $ref: '#/definitions/response.Response'
  2598. security:
  2599. - Bearer: []
  2600. summary: 创建配置管理
  2601. tags:
  2602. - 配置管理
  2603. /api/v1/sys-config/{id}:
  2604. get:
  2605. description: 根据Key获取SysConfig的Service
  2606. parameters:
  2607. - description: configKey
  2608. in: path
  2609. name: configKey
  2610. type: string
  2611. responses:
  2612. "200":
  2613. description: '{"code": 200, "data": [...]}'
  2614. schema:
  2615. allOf:
  2616. - $ref: '#/definitions/response.Response'
  2617. - properties:
  2618. data:
  2619. $ref: '#/definitions/dto.SysConfigByKeyReq'
  2620. type: object
  2621. security:
  2622. - Bearer: []
  2623. summary: 根据Key获取SysConfig的Service
  2624. tags:
  2625. - 配置管理
  2626. put:
  2627. consumes:
  2628. - application/json
  2629. description: 修改配置管理
  2630. parameters:
  2631. - description: body
  2632. in: body
  2633. name: data
  2634. required: true
  2635. schema:
  2636. $ref: '#/definitions/dto.SysConfigControl'
  2637. responses:
  2638. "200":
  2639. description: '{"code": 200, "message": "修改成功"}'
  2640. schema:
  2641. $ref: '#/definitions/response.Response'
  2642. security:
  2643. - Bearer: []
  2644. summary: 修改配置管理
  2645. tags:
  2646. - 配置管理
  2647. /api/v1/sys-login-log:
  2648. delete:
  2649. description: 登录日志删除
  2650. parameters:
  2651. - description: body
  2652. in: body
  2653. name: data
  2654. required: true
  2655. schema:
  2656. $ref: '#/definitions/dto.SysLoginLogDeleteReq'
  2657. responses:
  2658. "200":
  2659. description: '{"code": 200, "data": [...]}'
  2660. schema:
  2661. $ref: '#/definitions/response.Response'
  2662. security:
  2663. - Bearer: []
  2664. summary: 登录日志删除
  2665. tags:
  2666. - 登录日志
  2667. get:
  2668. description: 获取JSON
  2669. parameters:
  2670. - description: 用户名
  2671. in: query
  2672. name: username
  2673. type: string
  2674. - description: ip地址
  2675. in: query
  2676. name: ipaddr
  2677. type: string
  2678. - description: 归属地
  2679. in: query
  2680. name: loginLocation
  2681. type: string
  2682. - description: 状态
  2683. in: query
  2684. name: status
  2685. type: string
  2686. - description: 开始时间
  2687. in: query
  2688. name: beginTime
  2689. type: string
  2690. - description: 结束时间
  2691. in: query
  2692. name: endTime
  2693. type: string
  2694. responses:
  2695. "200":
  2696. description: '{"code": 200, "data": [...]}'
  2697. schema:
  2698. $ref: '#/definitions/response.Response'
  2699. security:
  2700. - Bearer: []
  2701. summary: 登录日志列表
  2702. tags:
  2703. - 登录日志
  2704. /api/v1/sys-login-log/{id}:
  2705. get:
  2706. description: 获取JSON
  2707. parameters:
  2708. - description: id
  2709. in: path
  2710. name: id
  2711. type: string
  2712. responses:
  2713. "200":
  2714. description: '{"code": 200, "data": [...]}'
  2715. schema:
  2716. $ref: '#/definitions/response.Response'
  2717. security:
  2718. - Bearer: []
  2719. summary: 登录日志通过id获取
  2720. tags:
  2721. - 登录日志
  2722. /api/v1/sys-opera-log:
  2723. delete:
  2724. description: 删除数据
  2725. parameters:
  2726. - description: body
  2727. in: body
  2728. name: data
  2729. required: true
  2730. schema:
  2731. $ref: '#/definitions/dto.SysOperaLogDeleteReq'
  2732. responses:
  2733. "200":
  2734. description: '{"code": 200, "data": [...]}'
  2735. schema:
  2736. $ref: '#/definitions/response.Response'
  2737. security:
  2738. - Bearer: []
  2739. summary: 删除操作日志
  2740. tags:
  2741. - 操作日志
  2742. get:
  2743. description: 获取JSON
  2744. parameters:
  2745. - description: title
  2746. in: query
  2747. name: title
  2748. type: string
  2749. - description: method
  2750. in: query
  2751. name: method
  2752. type: string
  2753. - description: requestMethod
  2754. in: query
  2755. name: requestMethod
  2756. type: string
  2757. - description: operUrl
  2758. in: query
  2759. name: operUrl
  2760. type: string
  2761. - description: operIp
  2762. in: query
  2763. name: operIp
  2764. type: string
  2765. - description: status
  2766. in: query
  2767. name: status
  2768. type: string
  2769. - description: beginTime
  2770. in: query
  2771. name: beginTime
  2772. type: string
  2773. - description: endTime
  2774. in: query
  2775. name: endTime
  2776. type: string
  2777. responses:
  2778. "200":
  2779. description: '{"code": 200, "data": [...]}'
  2780. schema:
  2781. $ref: '#/definitions/response.Response'
  2782. security:
  2783. - Bearer: []
  2784. summary: 操作日志列表
  2785. tags:
  2786. - 操作日志
  2787. /api/v1/sys-opera-log/{id}:
  2788. get:
  2789. description: 获取JSON
  2790. parameters:
  2791. - description: id
  2792. in: path
  2793. name: id
  2794. type: string
  2795. responses:
  2796. "200":
  2797. description: '{"code": 200, "data": [...]}'
  2798. schema:
  2799. $ref: '#/definitions/response.Response'
  2800. security:
  2801. - Bearer: []
  2802. summary: 操作日志通过id获取
  2803. tags:
  2804. - 操作日志
  2805. /api/v1/sys-user:
  2806. get:
  2807. description: 获取JSON
  2808. parameters:
  2809. - description: username
  2810. in: query
  2811. name: username
  2812. type: string
  2813. responses:
  2814. "200":
  2815. description: '{"code": 200, "data": [...]}'
  2816. schema:
  2817. type: string
  2818. security:
  2819. - Bearer: []
  2820. summary: 列表用户信息数据
  2821. tags:
  2822. - 用户
  2823. post:
  2824. consumes:
  2825. - application/json
  2826. description: 获取JSON
  2827. parameters:
  2828. - description: 用户数据
  2829. in: body
  2830. name: data
  2831. required: true
  2832. schema:
  2833. $ref: '#/definitions/dto.SysUserInsertReq'
  2834. responses:
  2835. "200":
  2836. description: '{"code": 200, "data": [...]}'
  2837. schema:
  2838. $ref: '#/definitions/response.Response'
  2839. security:
  2840. - Bearer: []
  2841. summary: 创建用户
  2842. tags:
  2843. - 用户
  2844. /api/v1/sys-user/{userId}:
  2845. delete:
  2846. description: 删除数据
  2847. parameters:
  2848. - description: userId
  2849. in: path
  2850. name: userId
  2851. required: true
  2852. type: integer
  2853. responses:
  2854. "200":
  2855. description: '{"code": 200, "data": [...]}'
  2856. schema:
  2857. $ref: '#/definitions/response.Response'
  2858. security:
  2859. - Bearer: []
  2860. summary: 删除用户数据
  2861. tags:
  2862. - 用户
  2863. get:
  2864. description: 获取JSON
  2865. parameters:
  2866. - description: 用户编码
  2867. in: path
  2868. name: userId
  2869. required: true
  2870. type: integer
  2871. responses:
  2872. "200":
  2873. description: '{"code": 200, "data": [...]}'
  2874. schema:
  2875. $ref: '#/definitions/response.Response'
  2876. security:
  2877. - Bearer: []
  2878. summary: 获取用户
  2879. tags:
  2880. - 用户
  2881. put:
  2882. consumes:
  2883. - application/json
  2884. description: 获取JSON
  2885. parameters:
  2886. - description: body
  2887. in: body
  2888. name: data
  2889. required: true
  2890. schema:
  2891. $ref: '#/definitions/dto.SysUserUpdateReq'
  2892. responses:
  2893. "200":
  2894. description: '{"code": 200, "data": [...]}'
  2895. schema:
  2896. $ref: '#/definitions/response.Response'
  2897. security:
  2898. - Bearer: []
  2899. summary: 修改用户数据
  2900. tags:
  2901. - 用户
  2902. /api/v1/sys/tables/info:
  2903. post:
  2904. consumes:
  2905. - application/json
  2906. description: 添加表结构
  2907. parameters:
  2908. - description: tableName / 数据表名称
  2909. in: query
  2910. name: tables
  2911. type: string
  2912. responses:
  2913. "200":
  2914. description: '{"code": -1, "message": "添加失败"}'
  2915. schema:
  2916. type: string
  2917. security:
  2918. - Bearer: []
  2919. summary: 添加表结构
  2920. tags:
  2921. - 工具 / 生成工具
  2922. put:
  2923. consumes:
  2924. - application/json
  2925. description: 修改表结构
  2926. parameters:
  2927. - description: body
  2928. in: body
  2929. name: data
  2930. required: true
  2931. schema:
  2932. $ref: '#/definitions/tools.SysTables'
  2933. responses:
  2934. "200":
  2935. description: '{"code": -1, "message": "添加失败"}'
  2936. schema:
  2937. type: string
  2938. security:
  2939. - Bearer: []
  2940. summary: 修改表结构
  2941. tags:
  2942. - 工具 / 生成工具
  2943. /api/v1/sys/tables/info/{tableId}:
  2944. delete:
  2945. description: 删除表结构
  2946. parameters:
  2947. - description: tableId
  2948. in: path
  2949. name: tableId
  2950. required: true
  2951. type: integer
  2952. responses:
  2953. "200":
  2954. description: '{"code": -1, "message": "删除失败"}'
  2955. schema:
  2956. type: string
  2957. summary: 删除表结构
  2958. tags:
  2959. - 工具 / 生成工具
  2960. get:
  2961. description: 获取JSON
  2962. parameters:
  2963. - description: configKey
  2964. in: path
  2965. name: configKey
  2966. required: true
  2967. type: integer
  2968. responses:
  2969. "200":
  2970. description: '{"code": 200, "data": [...]}'
  2971. schema:
  2972. $ref: '#/definitions/response.Response'
  2973. security:
  2974. - Bearer: []
  2975. summary: 获取配置
  2976. tags:
  2977. - 工具 / 生成工具
  2978. /api/v1/sys/tables/page:
  2979. get:
  2980. description: 生成表分页列表
  2981. parameters:
  2982. - description: tableName / 数据表名称
  2983. in: query
  2984. name: tableName
  2985. type: string
  2986. - description: pageSize / 页条数
  2987. in: query
  2988. name: pageSize
  2989. type: integer
  2990. - description: pageIndex / 页码
  2991. in: query
  2992. name: pageIndex
  2993. type: integer
  2994. responses:
  2995. "200":
  2996. description: '{"code": 200, "data": [...]}'
  2997. schema:
  2998. $ref: '#/definitions/response.Response'
  2999. summary: 分页列表数据
  3000. tags:
  3001. - 工具 / 生成工具
  3002. /api/v1/user/avatar:
  3003. post:
  3004. consumes:
  3005. - multipart/form-data
  3006. description: 获取JSON
  3007. parameters:
  3008. - description: file
  3009. in: formData
  3010. name: file
  3011. required: true
  3012. type: file
  3013. responses:
  3014. "200":
  3015. description: '{"code": 200, "data": [...]}'
  3016. schema:
  3017. $ref: '#/definitions/response.Response'
  3018. security:
  3019. - Bearer: []
  3020. summary: 修改头像
  3021. tags:
  3022. - 个人中心
  3023. /api/v1/user/profile:
  3024. get:
  3025. description: 获取JSON
  3026. responses:
  3027. "200":
  3028. description: '{"code": 200, "data": [...]}'
  3029. schema:
  3030. $ref: '#/definitions/response.Response'
  3031. security:
  3032. - Bearer: []
  3033. summary: 获取个人中心用户
  3034. tags:
  3035. - 个人中心
  3036. /api/v1/user/pwd/reset:
  3037. put:
  3038. consumes:
  3039. - application/json
  3040. description: 获取JSON
  3041. parameters:
  3042. - description: body
  3043. in: body
  3044. name: data
  3045. required: true
  3046. schema:
  3047. $ref: '#/definitions/dto.ResetSysUserPwdReq'
  3048. responses:
  3049. "200":
  3050. description: '{"code": 200, "data": [...]}'
  3051. schema:
  3052. $ref: '#/definitions/response.Response'
  3053. security:
  3054. - Bearer: []
  3055. summary: 重置用户密码
  3056. tags:
  3057. - 用户
  3058. /api/v1/user/pwd/set:
  3059. put:
  3060. consumes:
  3061. - application/json
  3062. description: 获取JSON
  3063. parameters:
  3064. - description: body
  3065. in: body
  3066. name: data
  3067. required: true
  3068. schema:
  3069. $ref: '#/definitions/dto.PassWord'
  3070. responses:
  3071. "200":
  3072. description: '{"code": 200, "data": [...]}'
  3073. schema:
  3074. $ref: '#/definitions/response.Response'
  3075. security:
  3076. - Bearer: []
  3077. summary: 重置密码
  3078. tags:
  3079. - 用户
  3080. /api/v1/user/status:
  3081. put:
  3082. consumes:
  3083. - application/json
  3084. description: 获取JSON
  3085. parameters:
  3086. - description: body
  3087. in: body
  3088. name: data
  3089. required: true
  3090. schema:
  3091. $ref: '#/definitions/dto.UpdateSysUserStatusReq'
  3092. responses:
  3093. "200":
  3094. description: '{"code": 200, "data": [...]}'
  3095. schema:
  3096. $ref: '#/definitions/response.Response'
  3097. security:
  3098. - Bearer: []
  3099. summary: 修改用户状态
  3100. tags:
  3101. - 用户
  3102. /api/v3/departments:
  3103. get:
  3104. description: 权限:只能查询到登录员工具有权限的组织
  3105. produces:
  3106. - application/json
  3107. responses:
  3108. "200":
  3109. description: OK
  3110. schema:
  3111. $ref: '#/definitions/controller.DepartmentItemVO'
  3112. summary: 查询部门列表
  3113. tags:
  3114. - 部门
  3115. /api/v3/departments/{deptID}:
  3116. delete:
  3117. parameters:
  3118. - description: 部门ID
  3119. in: path
  3120. name: deptID
  3121. required: true
  3122. type: integer
  3123. produces:
  3124. - application/json
  3125. responses:
  3126. "200":
  3127. description: OK
  3128. schema:
  3129. $ref: '#/definitions/controller.ErrVO'
  3130. "400":
  3131. description: 有关联员工,不允许删除
  3132. schema:
  3133. $ref: '#/definitions/controller.ErrVO'
  3134. "404":
  3135. description: 没有找到部门
  3136. schema:
  3137. $ref: '#/definitions/controller.ErrVO'
  3138. summary: 删除部门
  3139. tags:
  3140. - 部门
  3141. put:
  3142. consumes:
  3143. - application/json
  3144. parameters:
  3145. - description: 部门ID
  3146. in: path
  3147. name: deptID
  3148. required: true
  3149. type: integer
  3150. - description: 请求体
  3151. in: body
  3152. name: req-body
  3153. required: true
  3154. schema:
  3155. $ref: '#/definitions/controller.UpdateDepartmentReqVO'
  3156. produces:
  3157. - application/json
  3158. responses:
  3159. "200":
  3160. description: OK
  3161. schema:
  3162. $ref: '#/definitions/controller.UpdateDepartmentRespVO'
  3163. "400":
  3164. description: 缺少必要的参数
  3165. schema:
  3166. $ref: '#/definitions/controller.ErrVO'
  3167. "404":
  3168. description: 没有找到该部门/parentID/adminID
  3169. schema:
  3170. $ref: '#/definitions/controller.ErrVO'
  3171. summary: 修改某部门信息
  3172. tags:
  3173. - 部门
  3174. /api/v3/departments/{deptID}/children/batch:
  3175. post:
  3176. consumes:
  3177. - application/json
  3178. parameters:
  3179. - description: 上级部门id, 一级目录用0
  3180. in: path
  3181. name: deptID
  3182. required: true
  3183. type: integer
  3184. - description: 批量添加请求体
  3185. in: body
  3186. name: req-body
  3187. required: true
  3188. schema:
  3189. $ref: '#/definitions/controller.BatchAddDepartmentItemReqVO'
  3190. produces:
  3191. - application/json
  3192. responses:
  3193. "200":
  3194. description: OK
  3195. schema:
  3196. $ref: '#/definitions/controller.BatchAddDepartmentItemRespVO'
  3197. "400":
  3198. description: 相同部门名已存在
  3199. schema:
  3200. $ref: '#/definitions/controller.ErrVO'
  3201. "401":
  3202. description: 没有权限
  3203. schema:
  3204. $ref: '#/definitions/controller.ErrVO'
  3205. "404":
  3206. description: 没有找到对应的管理员
  3207. schema:
  3208. $ref: '#/definitions/controller.ErrVO'
  3209. summary: 批量增加下级组织到某组织
  3210. tags:
  3211. - 部门
  3212. /api/v3/departments/{deptID}/users:
  3213. post:
  3214. consumes:
  3215. - application/json
  3216. parameters:
  3217. - description: req
  3218. in: body
  3219. name: req
  3220. required: true
  3221. schema:
  3222. $ref: '#/definitions/controller.AttachUserToDepartmentReqVO'
  3223. - description: 部门ID
  3224. in: path
  3225. name: deptID
  3226. required: true
  3227. type: integer
  3228. produces:
  3229. - application/json
  3230. responses:
  3231. "200":
  3232. description: OK
  3233. schema:
  3234. $ref: '#/definitions/controller.AttachUserToDepartmentRespVO'
  3235. "404":
  3236. description: 没有找到导入记录
  3237. schema:
  3238. $ref: '#/definitions/controller.ErrVO'
  3239. summary: 用户尝试加入组织, 手机号匹配
  3240. tags:
  3241. - 部门
  3242. /api/v3/departments/employees:
  3243. get:
  3244. description: 返回中必然包含参数中提供的deptID的项,即使没有人员与该部门关联。除非该deptID并不存在
  3245. parameters:
  3246. - description: 部门id,支持多个. http://domain/path?deptID=1&deptID=2
  3247. in: query
  3248. items:
  3249. type: integer
  3250. name: deptID
  3251. required: true
  3252. type: array
  3253. produces:
  3254. - application/json
  3255. responses:
  3256. "200":
  3257. description: OK
  3258. schema:
  3259. $ref: '#/definitions/controller.ListUsersOfDepartmentsRespVO'
  3260. summary: 查询多个部门下的员工列表
  3261. tags:
  3262. - 部门
  3263. /api/v3/employee:
  3264. get:
  3265. parameters:
  3266. - description: 部门ID列表, deptID=1&deptID=2
  3267. in: query
  3268. items:
  3269. type: integer
  3270. name: deptID
  3271. type: array
  3272. - description: 岗位ID列表, occID=1&occID=2
  3273. in: query
  3274. items:
  3275. type: integer
  3276. name: occID
  3277. type: array
  3278. - description: 过滤关键字
  3279. in: query
  3280. name: filter
  3281. type: string
  3282. - default: id
  3283. description: 排序依据, createdTime/id
  3284. in: query
  3285. name: orderBy
  3286. type: string
  3287. - default: desc
  3288. description: 排序顺序, asc/desc
  3289. in: query
  3290. name: order
  3291. type: string
  3292. - default: 0
  3293. description: 分页偏移量
  3294. in: query
  3295. name: offset
  3296. type: integer
  3297. - default: 10
  3298. description: 分页个数
  3299. in: query
  3300. maximum: 50
  3301. name: limit
  3302. type: integer
  3303. produces:
  3304. - application/json
  3305. responses:
  3306. "200":
  3307. description: OK
  3308. schema:
  3309. $ref: '#/definitions/controller.ListEmployeeRespVO'
  3310. summary: 查询员工列表
  3311. tags:
  3312. - 员工
  3313. /api/v3/employee/{employeeID}:
  3314. delete:
  3315. parameters:
  3316. - description: 员工ID
  3317. in: path
  3318. name: employeeID
  3319. required: true
  3320. type: integer
  3321. produces:
  3322. - application/json
  3323. responses:
  3324. "200":
  3325. description: OK
  3326. schema:
  3327. $ref: '#/definitions/controller.ErrVO'
  3328. "404":
  3329. description: 未找到该员工
  3330. schema:
  3331. $ref: '#/definitions/controller.ErrVO'
  3332. summary: 删除单个员工
  3333. tags:
  3334. - 员工
  3335. put:
  3336. consumes:
  3337. - application/json
  3338. parameters:
  3339. - description: 员工ID
  3340. in: path
  3341. name: employeeID
  3342. required: true
  3343. type: integer
  3344. - description: 允许省略字段, 至少一个字段
  3345. in: body
  3346. name: req
  3347. required: true
  3348. schema:
  3349. $ref: '#/definitions/controller.UpdateEmployeeItemVO'
  3350. produces:
  3351. - application/json
  3352. responses:
  3353. "200":
  3354. description: OK
  3355. schema:
  3356. $ref: '#/definitions/controller.ErrVO'
  3357. "400":
  3358. description: 参数错误
  3359. schema:
  3360. $ref: '#/definitions/controller.ErrVO'
  3361. "404":
  3362. description: 员工未找到
  3363. schema:
  3364. $ref: '#/definitions/controller.ErrVO'
  3365. summary: 编辑员工信息
  3366. tags:
  3367. - 员工
  3368. /api/v3/employee/batch:
  3369. delete:
  3370. parameters:
  3371. - description: 员工ID, 允许多个 employeeID=1&employeeID=2
  3372. in: query
  3373. items:
  3374. type: integer
  3375. maximum: 50
  3376. name: employeeID
  3377. required: true
  3378. type: array
  3379. produces:
  3380. - application/json
  3381. responses:
  3382. "200":
  3383. description: OK
  3384. schema:
  3385. $ref: '#/definitions/controller.ErrVO'
  3386. "400":
  3387. description: 一次性删除过多
  3388. schema:
  3389. $ref: '#/definitions/controller.ErrVO'
  3390. "404":
  3391. description: 未找到某员工
  3392. schema:
  3393. $ref: '#/definitions/controller.ErrVO'
  3394. summary: 批量删除员工
  3395. tags:
  3396. - 员工
  3397. post:
  3398. consumes:
  3399. - application/json
  3400. parameters:
  3401. - description: 最多一次50个
  3402. in: body
  3403. name: req
  3404. required: true
  3405. schema:
  3406. $ref: '#/definitions/controller.BatchAddEmployeeReqVO'
  3407. produces:
  3408. - application/json
  3409. responses:
  3410. "200":
  3411. description: OK
  3412. schema:
  3413. $ref: '#/definitions/controller.ListEmployeeRespVO'
  3414. "400":
  3415. description: 员工信息已存在
  3416. schema:
  3417. $ref: '#/definitions/controller.ErrVO'
  3418. "451":
  3419. description: 超过一次添加的个数
  3420. schema:
  3421. $ref: '#/definitions/controller.ErrVO'
  3422. summary: 批量添加员工
  3423. tags:
  3424. - 员工
  3425. /api/v3/employee/batch/import:
  3426. post:
  3427. consumes:
  3428. - application/x-www-form-urlencoded
  3429. parameters:
  3430. - description: formData中对应文件的字段
  3431. in: formData
  3432. name: file
  3433. required: true
  3434. type: string
  3435. produces:
  3436. - application/json
  3437. responses:
  3438. "200":
  3439. description: OK
  3440. schema:
  3441. $ref: '#/definitions/controller.ListEmployeeRespVO'
  3442. "400":
  3443. description: 员工信息已存在
  3444. schema:
  3445. $ref: '#/definitions/controller.ErrVO'
  3446. "451":
  3447. description: 超过一次添加的个数
  3448. schema:
  3449. $ref: '#/definitions/controller.ErrVO'
  3450. summary: 批量导入员工
  3451. tags:
  3452. - 员工
  3453. /api/v3/employee/batch/template:
  3454. get:
  3455. produces:
  3456. - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
  3457. responses:
  3458. "200":
  3459. description: xlsx文件
  3460. schema:
  3461. type: string
  3462. summary: 获取批量导入的模板文件
  3463. tags:
  3464. - 员工
  3465. /api/v3/employee/tag/batch:
  3466. post:
  3467. consumes:
  3468. - application/json
  3469. parameters:
  3470. - description: 单次最多50个
  3471. in: body
  3472. name: req
  3473. required: true
  3474. schema:
  3475. $ref: '#/definitions/controller.BatchTagWithDepartmentAndOccupationReqVO'
  3476. produces:
  3477. - application/json
  3478. responses:
  3479. "200":
  3480. description: OK
  3481. schema:
  3482. $ref: '#/definitions/controller.ErrVO'
  3483. "400":
  3484. description: 单次操作数目过大
  3485. schema:
  3486. $ref: '#/definitions/controller.ErrVO'
  3487. "404":
  3488. description: 未找到员工
  3489. schema:
  3490. $ref: '#/definitions/controller.ErrVO'
  3491. "454":
  3492. description: 未找到部门
  3493. schema:
  3494. $ref: '#/definitions/controller.ErrVO'
  3495. "464":
  3496. description: 未找到岗位
  3497. schema:
  3498. $ref: '#/definitions/controller.ErrVO'
  3499. summary: 批量设置员工的部门和岗位
  3500. tags:
  3501. - 员工
  3502. /api/v3/occupations:
  3503. get:
  3504. parameters:
  3505. - default: id
  3506. description: 排序标准,关联员工数量userCnt/创建时间createdTime/id
  3507. in: query
  3508. name: orderBy
  3509. type: string
  3510. - default: desc
  3511. description: 排序顺序,顺序asc/倒序desc
  3512. in: query
  3513. name: order
  3514. type: string
  3515. - default: 0
  3516. description: 从第几个开始查询
  3517. in: query
  3518. name: offset
  3519. type: integer
  3520. - default: 10
  3521. description: 本次查询个数
  3522. in: query
  3523. maximum: 50
  3524. name: limit
  3525. type: integer
  3526. - description: 过滤关键词
  3527. in: query
  3528. name: filter
  3529. type: string
  3530. produces:
  3531. - application/json
  3532. responses:
  3533. "200":
  3534. description: OK
  3535. schema:
  3536. $ref: '#/definitions/controller.ListOccupationVO'
  3537. summary: 查询岗位列表
  3538. tags:
  3539. - 岗位
  3540. /api/v3/occupations/{occID}:
  3541. delete:
  3542. parameters:
  3543. - description: 岗位ID
  3544. in: path
  3545. name: occID
  3546. required: true
  3547. type: integer
  3548. produces:
  3549. - application/json
  3550. responses:
  3551. "200":
  3552. description: OK
  3553. schema:
  3554. $ref: '#/definitions/controller.ErrVO'
  3555. "400":
  3556. description: 有关联员工,不允许删除
  3557. schema:
  3558. $ref: '#/definitions/controller.ErrVO'
  3559. "404":
  3560. description: 未找到该岗位
  3561. schema:
  3562. $ref: '#/definitions/controller.ErrVO'
  3563. summary: 删除岗位
  3564. tags:
  3565. - 岗位
  3566. put:
  3567. parameters:
  3568. - description: 岗位ID
  3569. in: path
  3570. name: occID
  3571. required: true
  3572. type: integer
  3573. - description: 允许省略字段,至少一个字段
  3574. in: body
  3575. name: req
  3576. required: true
  3577. schema:
  3578. $ref: '#/definitions/controller.UpdateOccupationReqVO'
  3579. produces:
  3580. - application/json
  3581. responses:
  3582. "200":
  3583. description: OK
  3584. schema:
  3585. $ref: '#/definitions/controller.ErrVO'
  3586. "400":
  3587. description: 参数错误
  3588. schema:
  3589. $ref: '#/definitions/controller.ErrVO'
  3590. "404":
  3591. description: 未找到该岗位
  3592. schema:
  3593. $ref: '#/definitions/controller.ErrVO'
  3594. summary: 编辑岗位
  3595. tags:
  3596. - 岗位
  3597. /api/v3/occupations/{occID}/employees:
  3598. get:
  3599. parameters:
  3600. - description: 岗位ID
  3601. in: path
  3602. name: occID
  3603. required: true
  3604. type: integer
  3605. - description: 过滤关键词
  3606. in: query
  3607. name: filter
  3608. type: string
  3609. - default: 0
  3610. description: 从第几个开始查询
  3611. in: query
  3612. name: offset
  3613. type: integer
  3614. - default: 10
  3615. description: 查询个数
  3616. in: query
  3617. maximum: 50
  3618. name: limit
  3619. type: integer
  3620. - default: id
  3621. description: 排序标准, 关联时间linkedTime/id
  3622. in: query
  3623. name: order_by
  3624. type: string
  3625. - default: desc
  3626. description: 排序顺序,顺序asc/倒序desc
  3627. in: query
  3628. name: order
  3629. type: string
  3630. produces:
  3631. - application/json
  3632. responses:
  3633. "200":
  3634. description: OK
  3635. schema:
  3636. $ref: '#/definitions/controller.ListOccupationUsersRespVO'
  3637. summary: 获取某岗位下关联的员工
  3638. tags:
  3639. - 岗位
  3640. /api/v3/occupations/{occID}/users:
  3641. post:
  3642. consumes:
  3643. - application/json
  3644. parameters:
  3645. - description: 岗位ID
  3646. in: path
  3647. name: occID
  3648. required: true
  3649. type: integer
  3650. - description: 请求体
  3651. in: body
  3652. name: req
  3653. required: true
  3654. schema:
  3655. $ref: '#/definitions/controller.BatchLinkUsersToOccupationReqVO'
  3656. produces:
  3657. - application/json
  3658. responses:
  3659. "200":
  3660. description: OK
  3661. schema:
  3662. $ref: '#/definitions/controller.ErrVO'
  3663. "404":
  3664. description: 未找到该岗位
  3665. schema:
  3666. $ref: '#/definitions/controller.ErrVO'
  3667. "454":
  3668. description: 未找到某员工
  3669. schema:
  3670. $ref: '#/definitions/controller.ErrVO'
  3671. summary: 批量关联员工到某岗位
  3672. tags:
  3673. - 岗位
  3674. /api/v3/occupations/batch:
  3675. post:
  3676. consumes:
  3677. - application/json
  3678. parameters:
  3679. - description: 单次最多50个
  3680. in: body
  3681. name: req
  3682. required: true
  3683. schema:
  3684. $ref: '#/definitions/controller.BatchAddOccupationReqVO'
  3685. produces:
  3686. - application/json
  3687. responses:
  3688. "200":
  3689. description: OK
  3690. schema:
  3691. $ref: '#/definitions/controller.BatchAddOccupationRespVO'
  3692. "400":
  3693. description: 岗位已经存在
  3694. schema:
  3695. $ref: '#/definitions/controller.ErrVO'
  3696. "451":
  3697. description: 单次添加个数过大
  3698. schema:
  3699. $ref: '#/definitions/controller.ErrVO'
  3700. summary: 批量添加岗位
  3701. tags:
  3702. - 岗位
  3703. /api/v3/users/department:
  3704. put:
  3705. consumes:
  3706. - application/json
  3707. parameters:
  3708. - description: req
  3709. in: body
  3710. name: req
  3711. required: true
  3712. schema:
  3713. $ref: '#/definitions/controller.UserUpdateDepartmentReqVO'
  3714. produces:
  3715. - application/json
  3716. responses:
  3717. "200":
  3718. description: OK
  3719. schema:
  3720. $ref: '#/definitions/controller.UserUpdateDepartmentRespVO'
  3721. "400":
  3722. description: 该组织导入名单中不包括该员工,加入失败
  3723. schema:
  3724. $ref: '#/definitions/controller.ErrVO'
  3725. "404":
  3726. description: 未找到该组织
  3727. schema:
  3728. $ref: '#/definitions/controller.ErrVO'
  3729. summary: 用户申请加入某组织
  3730. tags:
  3731. - 用户
  3732. /api/v3/users/login:
  3733. post:
  3734. consumes:
  3735. - application/json
  3736. description: 手机号登录
  3737. parameters:
  3738. - description: 请求body
  3739. in: body
  3740. name: req
  3741. required: true
  3742. schema:
  3743. $ref: '#/definitions/controller.UserLoginReqVO'
  3744. produces:
  3745. - application/json
  3746. responses:
  3747. "200":
  3748. description: OK
  3749. schema:
  3750. $ref: '#/definitions/controller.UserLoginRespVO'
  3751. "400":
  3752. description: 用户名密码未找到或不匹配
  3753. schema:
  3754. $ref: '#/definitions/controller.ErrVO'
  3755. "403":
  3756. description: 用户已禁用
  3757. schema:
  3758. $ref: '#/definitions/controller.ErrVO'
  3759. summary: 用户登录
  3760. tags:
  3761. - 用户
  3762. /api/v3/users/register:
  3763. post:
  3764. consumes:
  3765. - application/json
  3766. description: 手机号注册. 有组织有匹配-加入组织,否则不加入任何组织
  3767. parameters:
  3768. - description: 请求body
  3769. in: body
  3770. name: req
  3771. required: true
  3772. schema:
  3773. $ref: '#/definitions/controller.UserRegisterReqVO'
  3774. produces:
  3775. - application/json
  3776. responses:
  3777. "200":
  3778. description: OK
  3779. schema:
  3780. $ref: '#/definitions/controller.UserRegisterRespVO'
  3781. "400":
  3782. description: 重复注册
  3783. schema:
  3784. $ref: '#/definitions/controller.ErrVO'
  3785. "451":
  3786. description: 验证码错误
  3787. schema:
  3788. $ref: '#/definitions/controller.ErrVO'
  3789. "452":
  3790. description: 手机号格式错误
  3791. schema:
  3792. $ref: '#/definitions/controller.ErrVO'
  3793. "453":
  3794. description: 密码不符合标准
  3795. schema:
  3796. $ref: '#/definitions/controller.ErrVO'
  3797. "454":
  3798. description: 注册成功,加入组织失败
  3799. schema:
  3800. $ref: '#/definitions/controller.ErrVO'
  3801. summary: 用户注册
  3802. tags:
  3803. - 用户
  3804. /logout:
  3805. post:
  3806. consumes:
  3807. - application/json
  3808. description: 获取token
  3809. responses:
  3810. "200":
  3811. description: '{"code": 200, "msg": "成功退出系统" }'
  3812. schema:
  3813. type: string
  3814. security:
  3815. - Bearer: []
  3816. summary: 退出登录
  3817. securityDefinitions:
  3818. Bearer:
  3819. in: header
  3820. name: Authorization
  3821. type: apiKey
  3822. swagger: "2.0"