api_data.json 101 KB

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