1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391339233933394339533963397339833993400340134023403340434053406340734083409341034113412341334143415341634173418 |
- // Package docs GENERATED BY THE COMMAND ABOVE; DO NOT EDIT
- // This file was generated by swaggo/swag
- package docs
- import (
- "bytes"
- "encoding/json"
- "strings"
- "text/template"
- "github.com/swaggo/swag"
- )
- var doc = `{
- "schemes": {{ marshal .Schemes }},
- "swagger": "2.0",
- "info": {
- "description": "{{escape .Description}}",
- "title": "{{.Title}}",
- "contact": {},
- "license": {
- "name": "MIT",
- "url": "https://github.com/xinliangnote/go-gin-api/blob/master/LICENSE"
- },
- "version": "{{.Version}}"
- },
- "host": "{{.Host}}",
- "basePath": "{{.BasePath}}",
- "paths": {
- "/api/admin": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "管理员列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "管理员列表",
- "parameters": [
- {
- "type": "integer",
- "default": 1,
- "description": "第几页",
- "name": "page",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "default": 10,
- "description": "每页显示条数",
- "name": "page_size",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "description": "用户名",
- "name": "username",
- "in": "query"
- },
- {
- "type": "string",
- "description": "昵称",
- "name": "nickname",
- "in": "query"
- },
- {
- "type": "string",
- "description": "手机号",
- "name": "mobile",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.listResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "新增管理员",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "新增管理员",
- "parameters": [
- {
- "type": "string",
- "description": "用户名",
- "name": "username",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "昵称",
- "name": "nickname",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "手机号",
- "name": "mobile",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "MD5后的密码",
- "name": "password",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.createResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/info": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "管理员详情",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "管理员详情",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.detailResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/logout": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "管理员登出",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "管理员登出",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.logoutResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/menu": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "提交菜单授权",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "提交菜单授权",
- "parameters": [
- {
- "type": "string",
- "description": "Hashid",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "功能权限ID,多个用,分割",
- "name": "actions",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.createResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/menu/{id}": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "菜单授权列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "菜单授权列表",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.listAdminMenuResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/modify_password": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "修改密码",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "修改密码",
- "parameters": [
- {
- "type": "string",
- "description": "旧密码",
- "name": "old_password",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "新密码",
- "name": "new_password",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.modifyPasswordResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/modify_personal_info": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "修改个人信息",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "修改个人信息",
- "parameters": [
- {
- "type": "string",
- "description": "昵称",
- "name": "nickname",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "手机号",
- "name": "mobile",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.modifyPersonalInfoResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/offline": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "下线管理员",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "下线管理员",
- "parameters": [
- {
- "type": "string",
- "description": "Hashid",
- "name": "id",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.offlineResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/reset_password/{id}": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "重置密码",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "重置密码",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.resetPasswordResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/used": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "更新管理员为启用/禁用",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "更新管理员为启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "Hashid",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "used",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.updateUsedResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/admin/{id}": {
- "delete": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "删除管理员",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "删除管理员",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.deleteResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/authorized": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "调用方列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "调用方列表",
- "parameters": [
- {
- "type": "integer",
- "default": 1,
- "description": "第几页",
- "name": "page",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "default": 10,
- "description": "每页显示条数",
- "name": "page_size",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "description": "调用方key",
- "name": "business_key",
- "in": "query"
- },
- {
- "type": "string",
- "description": "调用方secret",
- "name": "business_secret",
- "in": "query"
- },
- {
- "type": "string",
- "description": "调用方对接人",
- "name": "business_developer",
- "in": "query"
- },
- {
- "type": "string",
- "description": "备注",
- "name": "remark",
- "in": "path"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.listResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "新增调用方",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "新增调用方",
- "parameters": [
- {
- "type": "string",
- "description": "调用方key",
- "name": "business_key",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "调用方对接人",
- "name": "business_developer",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "备注",
- "name": "remark",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.createResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/authorized/used": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "更新调用方为启用/禁用",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "更新调用方为启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "hashID",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "used",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.updateUsedResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/authorized/{id}": {
- "delete": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "删除调用方",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "删除调用方",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.deleteResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/authorized_api": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "调用方接口地址列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "调用方接口地址列表",
- "parameters": [
- {
- "type": "string",
- "description": "hashID",
- "name": "id",
- "in": "query",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.listAPIResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "授权调用方接口地址",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "授权调用方接口地址",
- "parameters": [
- {
- "type": "string",
- "description": "HashID",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求方法",
- "name": "method",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求地址",
- "name": "api",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.createAPIResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/authorized_api/{id}": {
- "delete": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "删除调用方接口地址",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.authorized"
- ],
- "summary": "删除调用方接口地址",
- "parameters": [
- {
- "type": "string",
- "description": "主键ID",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/authorized.deleteAPIResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/config/email": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "修改邮件配置",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.config"
- ],
- "summary": "修改邮件配置",
- "parameters": [
- {
- "type": "string",
- "description": "邮箱服务器",
- "name": "host",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "端口",
- "name": "port",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "发件人邮箱",
- "name": "user",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "发件人密码",
- "name": "pass",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "收件人邮箱地址,多个用,分割",
- "name": "to",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/config.emailResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/cron": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "任务列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.cron"
- ],
- "summary": "任务列表",
- "parameters": [
- {
- "type": "integer",
- "default": 1,
- "description": "第几页",
- "name": "page",
- "in": "query",
- "required": true
- },
- {
- "type": "integer",
- "default": 10,
- "description": "每页显示条数",
- "name": "page_size",
- "in": "query",
- "required": true
- },
- {
- "type": "string",
- "description": "任务名称",
- "name": "name",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "执行方式 1:shell 2:http",
- "name": "protocol",
- "in": "query"
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "is_used",
- "in": "query"
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/cron.listResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "创建任务",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.cron"
- ],
- "summary": "创建任务",
- "parameters": [
- {
- "type": "string",
- "description": "任务名称",
- "name": "name",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "crontab 表达式",
- "name": "spec",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "执行命令",
- "name": "command",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "执行方式 1:shell 2:http",
- "name": "protocol",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "http 请求方式 1:get 2:post",
- "name": "http_method",
- "in": "formData"
- },
- {
- "type": "integer",
- "description": "超时时间(单位:秒)",
- "name": "timeout",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "重试次数",
- "name": "retry_times",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "重试间隔(单位:秒)",
- "name": "retry_interval",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知",
- "name": "notify_status",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "通知类型 1:邮件 2:webhook",
- "name": "notify_type",
- "in": "formData"
- },
- {
- "type": "string",
- "description": "通知者邮箱地址(多个用,分割)",
- "name": "notify_receiver_email",
- "in": "formData"
- },
- {
- "type": "string",
- "description": "通知匹配关键字(多个用,分割)",
- "name": "notify_keyword",
- "in": "formData"
- },
- {
- "type": "string",
- "description": "备注",
- "name": "remark",
- "in": "formData"
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "is_used",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/cron.createResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/cron/used": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "更新任务为启用/禁用",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.cron"
- ],
- "summary": "更新任务为启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "hashID",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "used",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/cron.updateUsedResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/cron/{id}": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "获取单条任务详情",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.cron"
- ],
- "summary": "获取单条任务详情",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/cron.detailResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "编辑任务",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.cron"
- ],
- "summary": "编辑任务",
- "parameters": [
- {
- "type": "string",
- "description": "hashID",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "任务名称",
- "name": "name",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "crontab 表达式",
- "name": "spec",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "执行命令",
- "name": "command",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "执行方式 1:shell 2:http",
- "name": "protocol",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "http 请求方式 1:get 2:post",
- "name": "http_method",
- "in": "formData"
- },
- {
- "type": "integer",
- "description": "超时时间(单位:秒)",
- "name": "timeout",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "重试次数",
- "name": "retry_times",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "重试间隔(单位:秒)",
- "name": "retry_interval",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知",
- "name": "notify_status",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "通知类型 1:邮件 2:webhook",
- "name": "notify_type",
- "in": "formData"
- },
- {
- "type": "string",
- "description": "通知者邮箱地址(多个用,分割)",
- "name": "notify_receiver_email",
- "in": "formData"
- },
- {
- "type": "string",
- "description": "通知匹配关键字(多个用,分割)",
- "name": "notify_keyword",
- "in": "formData"
- },
- {
- "type": "string",
- "description": "备注",
- "name": "remark",
- "in": "formData"
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "is_used",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/cron.modifyResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "手动执行单条任务",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.cron"
- ],
- "summary": "手动执行单条任务",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/cron.detailResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/login": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "管理员登录",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.admin"
- ],
- "summary": "管理员登录",
- "parameters": [
- {
- "type": "string",
- "description": "用户名",
- "name": "username",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "MD5后的密码",
- "name": "password",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/admin.loginResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/menu": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "菜单列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "菜单列表",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.listResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "创建/编辑菜单",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "创建/编辑菜单",
- "parameters": [
- {
- "description": "请求信息",
- "name": "Request",
- "in": "body",
- "required": true,
- "schema": {
- "$ref": "#/definitions/menu.createRequest"
- }
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.createResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/menu/sort": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "更新菜单排序",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "更新菜单排序",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "排序",
- "name": "sort",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.updateSortResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/menu/used": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "更新菜单为启用/禁用",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "更新菜单为启用/禁用",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "integer",
- "description": "是否启用 1:是 -1:否",
- "name": "used",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.updateUsedResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/menu/{id}": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "菜单详情",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "菜单详情",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.detailResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "delete": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "删除菜单",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "删除菜单",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.deleteResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/menu_action": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "功能权限列表",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "功能权限列表",
- "parameters": [
- {
- "type": "string",
- "description": "hashID",
- "name": "id",
- "in": "query",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.listActionResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- },
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "创建功能权限",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "创建功能权限",
- "parameters": [
- {
- "type": "string",
- "description": "HashID",
- "name": "id",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求方法",
- "name": "method",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求地址",
- "name": "api",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.createActionResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/menu_action/{id}": {
- "delete": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "删除功能权限",
- "consumes": [
- "application/json"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.menu"
- ],
- "summary": "删除功能权限",
- "parameters": [
- {
- "type": "string",
- "description": "hashId",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/menu.deleteActionResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/cache/clear": {
- "patch": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "清空缓存",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "清空缓存",
- "parameters": [
- {
- "type": "string",
- "description": "Redis Key",
- "name": "redis_key",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.searchCacheResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/cache/search": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "查询缓存",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "查询缓存",
- "parameters": [
- {
- "type": "string",
- "description": "Redis Key",
- "name": "redis_key",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.searchCacheResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/data/dbs": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "查询 DB",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "查询 DB",
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.dbsResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/data/mysql": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "执行 SQL 语句",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "执行 SQL 语句",
- "parameters": [
- {
- "type": "string",
- "description": "数据库名称",
- "name": "db_name",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "数据表名称",
- "name": "table_name",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "SQL 语句",
- "name": "sql",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.searchMySQLResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/data/tables": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "查询 Table",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "查询 Table",
- "parameters": [
- {
- "type": "string",
- "description": "数据库名称",
- "name": "db_name",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.tablesResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/hashids/decode/{id}": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "HashIds 解密",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "HashIds 解密",
- "parameters": [
- {
- "type": "string",
- "description": "需解密的密文",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.hashIdsDecodeResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/hashids/encode/{id}": {
- "get": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "HashIds 加密",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "HashIds 加密",
- "parameters": [
- {
- "type": "string",
- "description": "需加密的数字",
- "name": "id",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.hashIdsEncodeResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/api/tool/send_message": {
- "post": {
- "security": [
- {
- "LoginToken": []
- }
- ],
- "description": "发送消息",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "API.tool"
- ],
- "summary": "发送消息",
- "parameters": [
- {
- "type": "string",
- "description": "消息内容",
- "name": "message",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/tool.sendMessageResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/helper/md5/{str}": {
- "get": {
- "description": "加密",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Helper"
- ],
- "summary": "加密",
- "parameters": [
- {
- "type": "string",
- "description": "需要加密的字符串",
- "name": "str",
- "in": "path",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/helper.md5Response"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- },
- "/helper/sign": {
- "post": {
- "description": "签名",
- "consumes": [
- "application/x-www-form-urlencoded"
- ],
- "produces": [
- "application/json"
- ],
- "tags": [
- "Helper"
- ],
- "summary": "签名",
- "parameters": [
- {
- "type": "string",
- "description": "调用方 KEY",
- "name": "key",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求路径 (不附带 querystring),例如:/api/login",
- "name": "path",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求方式,例如:POST",
- "name": "method",
- "in": "formData",
- "required": true
- },
- {
- "type": "string",
- "description": "请求参数,例如:username=tom\u0026password=123456",
- "name": "params",
- "in": "formData",
- "required": true
- }
- ],
- "responses": {
- "200": {
- "description": "OK",
- "schema": {
- "$ref": "#/definitions/helper.signResponse"
- }
- },
- "400": {
- "description": "Bad Request",
- "schema": {
- "$ref": "#/definitions/code.Failure"
- }
- }
- }
- }
- }
- },
- "definitions": {
- "admin.ListMenuData": {
- "type": "object",
- "properties": {
- "id": {
- "description": "ID",
- "type": "integer"
- },
- "is_have": {
- "description": "是否已拥有权限",
- "type": "integer"
- },
- "name": {
- "description": "菜单名称",
- "type": "string"
- },
- "pid": {
- "description": "父类ID",
- "type": "integer"
- }
- }
- },
- "admin.ListMyMenuData": {
- "type": "object",
- "properties": {
- "icon": {
- "description": "图标",
- "type": "string"
- },
- "id": {
- "description": "ID",
- "type": "integer"
- },
- "link": {
- "description": "链接地址",
- "type": "string"
- },
- "name": {
- "description": "菜单名称",
- "type": "string"
- },
- "pid": {
- "description": "父类ID",
- "type": "integer"
- }
- }
- },
- "admin.createResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "admin.deleteResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "admin.detailResponse": {
- "type": "object",
- "properties": {
- "menu": {
- "description": "菜单栏",
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin.ListMyMenuData"
- }
- },
- "mobile": {
- "description": "手机号",
- "type": "string"
- },
- "nickname": {
- "description": "昵称",
- "type": "string"
- },
- "username": {
- "description": "用户名",
- "type": "string"
- }
- }
- },
- "admin.listAdminMenuResponse": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin.ListMenuData"
- }
- },
- "username": {
- "type": "string"
- }
- }
- },
- "admin.listData": {
- "type": "object",
- "properties": {
- "created_at": {
- "description": "创建时间",
- "type": "string"
- },
- "created_user": {
- "description": "创建人",
- "type": "string"
- },
- "hashid": {
- "description": "hashid",
- "type": "string"
- },
- "id": {
- "description": "ID",
- "type": "integer"
- },
- "is_online": {
- "description": "是否在线 1:是 -1:否",
- "type": "integer"
- },
- "is_used": {
- "description": "是否启用 1:是 -1:否",
- "type": "integer"
- },
- "mobile": {
- "description": "手机号",
- "type": "string"
- },
- "nickname": {
- "description": "昵称",
- "type": "string"
- },
- "updated_at": {
- "description": "更新时间",
- "type": "string"
- },
- "updated_user": {
- "description": "更新人",
- "type": "string"
- },
- "username": {
- "description": "用户名",
- "type": "string"
- }
- }
- },
- "admin.listResponse": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/admin.listData"
- }
- },
- "pagination": {
- "type": "object",
- "properties": {
- "current_page": {
- "type": "integer"
- },
- "per_page_count": {
- "type": "integer"
- },
- "total": {
- "type": "integer"
- }
- }
- }
- }
- },
- "admin.loginResponse": {
- "type": "object",
- "properties": {
- "token": {
- "description": "用户身份标识",
- "type": "string"
- }
- }
- },
- "admin.logoutResponse": {
- "type": "object",
- "properties": {
- "username": {
- "description": "用户账号",
- "type": "string"
- }
- }
- },
- "admin.modifyPasswordResponse": {
- "type": "object",
- "properties": {
- "username": {
- "description": "用户账号",
- "type": "string"
- }
- }
- },
- "admin.modifyPersonalInfoResponse": {
- "type": "object",
- "properties": {
- "username": {
- "description": "用户账号",
- "type": "string"
- }
- }
- },
- "admin.offlineResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "admin.resetPasswordResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "admin.updateUsedResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "authorized.createAPIResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "authorized.createResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "authorized.deleteAPIResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "authorized.deleteResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "authorized.listAPIData": {
- "type": "object",
- "properties": {
- "api": {
- "description": "调用方对接人",
- "type": "string"
- },
- "business_key": {
- "description": "调用方key",
- "type": "string"
- },
- "hash_id": {
- "description": "hashID",
- "type": "string"
- },
- "method": {
- "description": "调用方secret",
- "type": "string"
- }
- }
- },
- "authorized.listAPIResponse": {
- "type": "object",
- "properties": {
- "business_key": {
- "description": "调用方key",
- "type": "string"
- },
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorized.listAPIData"
- }
- }
- }
- },
- "authorized.listData": {
- "type": "object",
- "properties": {
- "business_developer": {
- "description": "调用方对接人",
- "type": "string"
- },
- "business_key": {
- "description": "调用方key",
- "type": "string"
- },
- "business_secret": {
- "description": "调用方secret",
- "type": "string"
- },
- "created_at": {
- "description": "创建时间",
- "type": "string"
- },
- "created_user": {
- "description": "创建人",
- "type": "string"
- },
- "hashid": {
- "description": "hashid",
- "type": "string"
- },
- "id": {
- "description": "ID",
- "type": "integer"
- },
- "is_used": {
- "description": "是否启用 1:是 -1:否",
- "type": "integer"
- },
- "remark": {
- "description": "备注",
- "type": "string"
- },
- "updated_at": {
- "description": "更新时间",
- "type": "string"
- },
- "updated_user": {
- "description": "更新人",
- "type": "string"
- }
- }
- },
- "authorized.listResponse": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/authorized.listData"
- }
- },
- "pagination": {
- "type": "object",
- "properties": {
- "current_page": {
- "type": "integer"
- },
- "per_page_count": {
- "type": "integer"
- },
- "total": {
- "type": "integer"
- }
- }
- }
- }
- },
- "authorized.updateUsedResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "code.Failure": {
- "type": "object",
- "properties": {
- "code": {
- "description": "业务码",
- "type": "integer"
- },
- "message": {
- "description": "描述信息",
- "type": "string"
- }
- }
- },
- "config.emailResponse": {
- "type": "object",
- "properties": {
- "email": {
- "description": "邮箱地址",
- "type": "string"
- }
- }
- },
- "cron.createResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "cron.detailResponse": {
- "type": "object",
- "properties": {
- "command": {
- "description": "执行命令",
- "type": "string"
- },
- "http_method": {
- "description": "http 请求方式 1:get 2:post",
- "type": "integer"
- },
- "is_used": {
- "description": "是否启用 1:是 -1:否",
- "type": "integer"
- },
- "name": {
- "description": "任务名称",
- "type": "string"
- },
- "notify_keyword": {
- "description": "通知匹配关键字(多个用,分割)",
- "type": "string"
- },
- "notify_receiver_email": {
- "description": "通知者邮箱地址(多个用,分割)",
- "type": "string"
- },
- "notify_status": {
- "description": "执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知",
- "type": "integer"
- },
- "notify_type": {
- "description": "通知类型 1:邮件 2:webhook",
- "type": "integer"
- },
- "protocol": {
- "description": "执行方式 1:shell 2:http",
- "type": "integer"
- },
- "remark": {
- "description": "备注",
- "type": "string"
- },
- "retry_interval": {
- "description": "重试间隔(单位:秒)",
- "type": "integer"
- },
- "retry_times": {
- "description": "重试次数",
- "type": "integer"
- },
- "spec": {
- "description": "crontab 表达式",
- "type": "string"
- },
- "timeout": {
- "description": "超时时间(单位:秒)",
- "type": "integer"
- }
- }
- },
- "cron.listData": {
- "type": "object",
- "properties": {
- "command": {
- "description": "执行命令",
- "type": "string"
- },
- "created_at": {
- "description": "创建时间",
- "type": "string"
- },
- "created_user": {
- "description": "创建人",
- "type": "string"
- },
- "hashid": {
- "description": "hashid",
- "type": "string"
- },
- "http_method": {
- "description": "http 请求方式 1:get 2:post",
- "type": "integer"
- },
- "http_method_text": {
- "description": "http 请求方式",
- "type": "string"
- },
- "id": {
- "description": "ID",
- "type": "integer"
- },
- "is_used": {
- "description": "是否启用 1=启用 2=禁用",
- "type": "integer"
- },
- "is_used_text": {
- "description": "是否启用",
- "type": "string"
- },
- "name": {
- "description": "任务名称",
- "type": "string"
- },
- "notify_status": {
- "description": "执行结束是否通知 1:不通知 2:失败通知 3:结束通知 4:结果关键字匹配通知",
- "type": "integer"
- },
- "notify_status_text": {
- "description": "执行结束是否通知",
- "type": "string"
- },
- "protocol": {
- "description": "执行方式 1:shell 2:http",
- "type": "integer"
- },
- "protocol_text": {
- "description": "执行方式",
- "type": "string"
- },
- "retry_interval": {
- "description": "重试间隔(单位:秒)",
- "type": "integer"
- },
- "retry_times": {
- "description": "重试次数",
- "type": "integer"
- },
- "spec": {
- "description": "crontab 表达式",
- "type": "string"
- },
- "timeout": {
- "description": "超时时间(单位:秒)",
- "type": "integer"
- },
- "updated_at": {
- "description": "更新时间",
- "type": "string"
- },
- "updated_user": {
- "description": "更新人",
- "type": "string"
- }
- }
- },
- "cron.listResponse": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/cron.listData"
- }
- },
- "pagination": {
- "type": "object",
- "properties": {
- "current_page": {
- "type": "integer"
- },
- "per_page_count": {
- "type": "integer"
- },
- "total": {
- "type": "integer"
- }
- }
- }
- }
- },
- "cron.modifyResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "cron.updateUsedResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "helper.md5Response": {
- "type": "object",
- "properties": {
- "md5_str": {
- "description": "MD5后的字符串",
- "type": "string"
- }
- }
- },
- "helper.signResponse": {
- "type": "object",
- "properties": {
- "authorization": {
- "description": "签名信息-Authorization",
- "type": "string"
- },
- "authorization_date": {
- "description": "签名信息-Authorization-Date",
- "type": "string"
- }
- }
- },
- "menu.createActionResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "menu.createRequest": {
- "type": "object",
- "properties": {
- "icon": {
- "description": "图标",
- "type": "string"
- },
- "id": {
- "description": "ID",
- "type": "string"
- },
- "level": {
- "description": "菜单类型 1:一级菜单 2:二级菜单",
- "type": "integer"
- },
- "link": {
- "description": "链接地址",
- "type": "string"
- },
- "name": {
- "description": "菜单名称",
- "type": "string"
- },
- "pid": {
- "description": "父类ID",
- "type": "integer"
- }
- }
- },
- "menu.createResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "menu.deleteActionResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "menu.deleteResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "menu.detailResponse": {
- "type": "object",
- "properties": {
- "icon": {
- "description": "图标",
- "type": "string"
- },
- "id": {
- "description": "主键ID",
- "type": "integer"
- },
- "link": {
- "description": "链接地址",
- "type": "string"
- },
- "name": {
- "description": "菜单名称",
- "type": "string"
- },
- "pid": {
- "description": "父类ID",
- "type": "integer"
- }
- }
- },
- "menu.listActionData": {
- "type": "object",
- "properties": {
- "api": {
- "description": "调用方对接人",
- "type": "string"
- },
- "hash_id": {
- "description": "hashID",
- "type": "string"
- },
- "menu_id": {
- "description": "菜单栏ID",
- "type": "integer"
- },
- "method": {
- "description": "调用方secret",
- "type": "string"
- }
- }
- },
- "menu.listActionResponse": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/menu.listActionData"
- }
- },
- "menu_name": {
- "type": "string"
- }
- }
- },
- "menu.listData": {
- "type": "object",
- "properties": {
- "hashid": {
- "description": "hashid",
- "type": "string"
- },
- "icon": {
- "description": "图标",
- "type": "string"
- },
- "id": {
- "description": "ID",
- "type": "integer"
- },
- "is_used": {
- "description": "是否启用 1=启用 -1=禁用",
- "type": "integer"
- },
- "link": {
- "description": "链接地址",
- "type": "string"
- },
- "name": {
- "description": "菜单名称",
- "type": "string"
- },
- "pid": {
- "description": "父类ID",
- "type": "integer"
- },
- "sort": {
- "description": "排序",
- "type": "integer"
- }
- }
- },
- "menu.listResponse": {
- "type": "object",
- "properties": {
- "list": {
- "type": "array",
- "items": {
- "$ref": "#/definitions/menu.listData"
- }
- }
- }
- },
- "menu.updateSortResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "menu.updateUsedResponse": {
- "type": "object",
- "properties": {
- "id": {
- "description": "主键ID",
- "type": "integer"
- }
- }
- },
- "tool.dbData": {
- "type": "object",
- "properties": {
- "db_name": {
- "description": "数据库名称",
- "type": "string"
- }
- }
- },
- "tool.dbsResponse": {
- "type": "object",
- "properties": {
- "list": {
- "description": "数据库列表",
- "type": "array",
- "items": {
- "$ref": "#/definitions/tool.dbData"
- }
- }
- }
- },
- "tool.hashIdsDecodeResponse": {
- "type": "object",
- "properties": {
- "val": {
- "description": "解密后的值",
- "type": "integer"
- }
- }
- },
- "tool.hashIdsEncodeResponse": {
- "type": "object",
- "properties": {
- "val": {
- "description": "加密后的值",
- "type": "string"
- }
- }
- },
- "tool.searchCacheResponse": {
- "type": "object",
- "properties": {
- "ttl": {
- "description": "过期时间",
- "type": "string"
- },
- "val": {
- "description": "查询后的值",
- "type": "string"
- }
- }
- },
- "tool.searchMySQLResponse": {
- "type": "object",
- "properties": {
- "cols": {
- "description": "查询后的行",
- "type": "array",
- "items": {
- "type": "string"
- }
- },
- "cols_info": {
- "description": "行信息",
- "type": "array",
- "items": {
- "$ref": "#/definitions/tool.tableColumn"
- }
- },
- "list": {
- "description": "查询后的数据",
- "type": "array",
- "items": {
- "type": "object",
- "additionalProperties": true
- }
- }
- }
- },
- "tool.sendMessageResponse": {
- "type": "object",
- "properties": {
- "status": {
- "description": "状态",
- "type": "string"
- }
- }
- },
- "tool.tableColumn": {
- "type": "object",
- "properties": {
- "column_comment": {
- "description": "字段注释",
- "type": "string"
- },
- "column_name": {
- "description": "字段名称",
- "type": "string"
- }
- }
- },
- "tool.tableData": {
- "type": "object",
- "properties": {
- "table_comment": {
- "description": "数据表备注",
- "type": "string"
- },
- "table_name": {
- "description": "数据表名称",
- "type": "string"
- }
- }
- },
- "tool.tablesResponse": {
- "type": "object",
- "properties": {
- "list": {
- "description": "数据表列表",
- "type": "array",
- "items": {
- "$ref": "#/definitions/tool.tableData"
- }
- }
- }
- }
- },
- "securityDefinitions": {
- "LoginToken": {
- "type": "apiKey",
- "name": "token",
- "in": "header"
- }
- }
- }`
- type swaggerInfo struct {
- Version string
- Host string
- BasePath string
- Schemes []string
- Title string
- Description string
- }
- // SwaggerInfo holds exported Swagger Info so clients can modify it
- var SwaggerInfo = swaggerInfo{
- Version: "2.0",
- Host: "",
- BasePath: "/",
- Schemes: []string{},
- Title: "swagger 接口文档",
- Description: "",
- }
- type s struct{}
- func (s *s) ReadDoc() string {
- sInfo := SwaggerInfo
- sInfo.Description = strings.Replace(sInfo.Description, "\n", "\\n", -1)
- t, err := template.New("swagger_info").Funcs(template.FuncMap{
- "marshal": func(v interface{}) string {
- a, _ := json.Marshal(v)
- return string(a)
- },
- "escape": func(v interface{}) string {
- // escape tabs
- str := strings.Replace(v.(string), "\t", "\\t", -1)
- // replace " with \", and if that results in \\", replace that with \\\"
- str = strings.Replace(str, "\"", "\\\"", -1)
- return strings.Replace(str, "\\\\\"", "\\\\\\\"", -1)
- },
- }).Parse(doc)
- if err != nil {
- return doc
- }
- var tpl bytes.Buffer
- if err := t.Execute(&tpl, sInfo); err != nil {
- return doc
- }
- return tpl.String()
- }
- func init() {
- swag.Register("swagger", &s{})
- }
|