docs.go 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689
  1. // Package docs GENERATED BY SWAG; DO NOT EDIT
  2. // This file was generated by swaggo/swag
  3. package docs
  4. import "github.com/swaggo/swag"
  5. const docTemplate = `{
  6. "schemes": {{ marshal .Schemes }},
  7. "swagger": "2.0",
  8. "info": {
  9. "description": "{{escape .Description}}",
  10. "title": "{{.Title}}",
  11. "contact": {},
  12. "version": "{{.Version}}"
  13. },
  14. "host": "{{.Host}}",
  15. "basePath": "{{.BasePath}}",
  16. "paths": {
  17. "/Account/AddUser": {
  18. "post": {
  19. "security": [
  20. {
  21. "ApiKeyAuth": []
  22. }
  23. ],
  24. "consumes": [
  25. "application/json"
  26. ],
  27. "produces": [
  28. "application/json"
  29. ],
  30. "tags": [
  31. "账户服务"
  32. ],
  33. "summary": "实名认证添加用户",
  34. "parameters": [
  35. {
  36. "description": "入参",
  37. "name": "data",
  38. "in": "body",
  39. "required": true,
  40. "schema": {
  41. "$ref": "#/definitions/request.AddUserReq"
  42. }
  43. }
  44. ],
  45. "responses": {
  46. "200": {
  47. "description": "出参",
  48. "schema": {
  49. "allOf": [
  50. {
  51. "$ref": "#/definitions/response.Response"
  52. },
  53. {
  54. "type": "object",
  55. "properties": {
  56. "msg": {
  57. "type": "string"
  58. }
  59. }
  60. }
  61. ]
  62. }
  63. }
  64. }
  65. }
  66. },
  67. "/Account/CreateContractAndAddSigner": {
  68. "post": {
  69. "security": [
  70. {
  71. "ApiKeyAuth": []
  72. }
  73. ],
  74. "consumes": [
  75. "application/json"
  76. ],
  77. "produces": [
  78. "application/json"
  79. ],
  80. "tags": [
  81. "账户服务"
  82. ],
  83. "summary": "上传待签署文件和添加签署方",
  84. "parameters": [
  85. {
  86. "description": "入参",
  87. "name": "data",
  88. "in": "body",
  89. "required": true,
  90. "schema": {
  91. "$ref": "#/definitions/request.CreateContractAndAddSignerReq"
  92. }
  93. }
  94. ],
  95. "responses": {
  96. "200": {
  97. "description": "出参",
  98. "schema": {
  99. "allOf": [
  100. {
  101. "$ref": "#/definitions/response.Response"
  102. },
  103. {
  104. "type": "object",
  105. "properties": {
  106. "data": {
  107. "type": "string"
  108. },
  109. "msg": {
  110. "type": "string"
  111. }
  112. }
  113. }
  114. ]
  115. }
  116. }
  117. }
  118. }
  119. },
  120. "/Account/Login": {
  121. "post": {
  122. "consumes": [
  123. "application/json"
  124. ],
  125. "produces": [
  126. "application/json"
  127. ],
  128. "tags": [
  129. "账户服务"
  130. ],
  131. "summary": "账户登录",
  132. "parameters": [
  133. {
  134. "description": "登录入参",
  135. "name": "data",
  136. "in": "body",
  137. "required": true,
  138. "schema": {
  139. "$ref": "#/definitions/request.LoginReq"
  140. }
  141. }
  142. ],
  143. "responses": {
  144. "200": {
  145. "description": "返回包括用户信息,token,过期时间",
  146. "schema": {
  147. "allOf": [
  148. {
  149. "$ref": "#/definitions/response.Response"
  150. },
  151. {
  152. "type": "object",
  153. "properties": {
  154. "data": {
  155. "$ref": "#/definitions/response.LoginRsp"
  156. },
  157. "msg": {
  158. "type": "string"
  159. }
  160. }
  161. }
  162. ]
  163. }
  164. }
  165. }
  166. }
  167. },
  168. "/Account/Loginout": {
  169. "get": {
  170. "security": [
  171. {
  172. "ApiKeyAuth": []
  173. }
  174. ],
  175. "consumes": [
  176. "application/json"
  177. ],
  178. "produces": [
  179. "application/json"
  180. ],
  181. "tags": [
  182. "账户服务"
  183. ],
  184. "summary": "用户登出请求",
  185. "responses": {
  186. "200": {
  187. "description": "出参",
  188. "schema": {
  189. "allOf": [
  190. {
  191. "$ref": "#/definitions/response.Response"
  192. },
  193. {
  194. "type": "object",
  195. "properties": {
  196. "msg": {
  197. "type": "string"
  198. }
  199. }
  200. }
  201. ]
  202. }
  203. }
  204. }
  205. }
  206. },
  207. "/Account/QueryUserESignRecord": {
  208. "get": {
  209. "security": [
  210. {
  211. "ApiKeyAuth": []
  212. }
  213. ],
  214. "consumes": [
  215. "application/json"
  216. ],
  217. "produces": [
  218. "application/json"
  219. ],
  220. "tags": [
  221. "账户服务"
  222. ],
  223. "summary": "查询用户电子签记录表",
  224. "responses": {
  225. "200": {
  226. "description": "出参",
  227. "schema": {
  228. "allOf": [
  229. {
  230. "$ref": "#/definitions/response.Response"
  231. },
  232. {
  233. "type": "object",
  234. "properties": {
  235. "data": {
  236. "type": "array",
  237. "items": {
  238. "$ref": "#/definitions/account.Useresignrecord"
  239. }
  240. },
  241. "msg": {
  242. "type": "string"
  243. }
  244. }
  245. }
  246. ]
  247. }
  248. }
  249. }
  250. }
  251. },
  252. "/Account/SignCompleted": {
  253. "post": {
  254. "security": [
  255. {
  256. "ApiKeyAuth": []
  257. }
  258. ],
  259. "consumes": [
  260. "application/json"
  261. ],
  262. "produces": [
  263. "application/json"
  264. ],
  265. "tags": [
  266. "账户服务"
  267. ],
  268. "summary": "提交实名认证",
  269. "responses": {
  270. "200": {
  271. "description": "出参",
  272. "schema": {
  273. "allOf": [
  274. {
  275. "$ref": "#/definitions/response.Response"
  276. },
  277. {
  278. "type": "object",
  279. "properties": {
  280. "msg": {
  281. "type": "string"
  282. }
  283. }
  284. }
  285. ]
  286. }
  287. }
  288. }
  289. }
  290. },
  291. "/Account/TokenCheck": {
  292. "get": {
  293. "security": [
  294. {
  295. "ApiKeyAuth": []
  296. }
  297. ],
  298. "consumes": [
  299. "application/json"
  300. ],
  301. "produces": [
  302. "application/json"
  303. ],
  304. "tags": [
  305. "账户服务"
  306. ],
  307. "summary": "Token校验",
  308. "responses": {
  309. "200": {
  310. "description": "操作成功",
  311. "schema": {
  312. "allOf": [
  313. {
  314. "$ref": "#/definitions/response.Response"
  315. },
  316. {
  317. "type": "object",
  318. "properties": {
  319. "msg": {
  320. "type": "string"
  321. }
  322. }
  323. }
  324. ]
  325. }
  326. }
  327. }
  328. }
  329. },
  330. "/MQ/SendMsgToMQ": {
  331. "post": {
  332. "security": [
  333. {
  334. "ApiKeyAuth": []
  335. }
  336. ],
  337. "consumes": [
  338. "application/json"
  339. ],
  340. "produces": [
  341. "application/json"
  342. ],
  343. "tags": [
  344. "总线业务"
  345. ],
  346. "summary": "总线业务",
  347. "parameters": [
  348. {
  349. "description": "入参",
  350. "name": "data",
  351. "in": "body",
  352. "required": true,
  353. "schema": {
  354. "$ref": "#/definitions/request.MQBodyReq"
  355. }
  356. }
  357. ],
  358. "responses": {
  359. "200": {
  360. "description": "出参",
  361. "schema": {
  362. "allOf": [
  363. {
  364. "$ref": "#/definitions/response.Response"
  365. },
  366. {
  367. "type": "object",
  368. "properties": {
  369. "data": {
  370. "$ref": "#/definitions/response.MQBodyRsp"
  371. },
  372. "msg": {
  373. "type": "string"
  374. }
  375. }
  376. }
  377. ]
  378. }
  379. }
  380. }
  381. }
  382. },
  383. "/MQ/SendNtfToMQ": {
  384. "post": {
  385. "consumes": [
  386. "application/json"
  387. ],
  388. "produces": [
  389. "application/json"
  390. ],
  391. "tags": [
  392. "总线业务"
  393. ],
  394. "summary": "总线通知",
  395. "parameters": [
  396. {
  397. "description": "入参",
  398. "name": "data",
  399. "in": "body",
  400. "required": true,
  401. "schema": {
  402. "$ref": "#/definitions/request.MQNtfReq"
  403. }
  404. }
  405. ],
  406. "responses": {
  407. "200": {
  408. "description": "出参",
  409. "schema": {
  410. "allOf": [
  411. {
  412. "$ref": "#/definitions/response.Response"
  413. },
  414. {
  415. "type": "object",
  416. "properties": {
  417. "msg": {
  418. "type": "string"
  419. }
  420. }
  421. }
  422. ]
  423. }
  424. }
  425. }
  426. }
  427. }
  428. },
  429. "definitions": {
  430. "account.Useresignrecord": {
  431. "type": "object",
  432. "properties": {
  433. "authinfo": {
  434. "description": "认证信息",
  435. "type": "string"
  436. },
  437. "contractfileaddr": {
  438. "description": "合同签署文件地址",
  439. "type": "string"
  440. },
  441. "contractno": {
  442. "description": "合同编号",
  443. "type": "string"
  444. },
  445. "createtime": {
  446. "description": "创建时间",
  447. "type": "string"
  448. },
  449. "creatorid": {
  450. "description": "创建人",
  451. "type": "integer"
  452. },
  453. "orderindex": {
  454. "description": "显示顺序",
  455. "type": "integer"
  456. },
  457. "recordid": {
  458. "description": "记录ID(SEQ_USERESIGNRECORD)",
  459. "type": "integer"
  460. },
  461. "recordstatus": {
  462. "description": "记录状态 - 1:未签署 2:签署中 3:已签署 4:签署拒绝",
  463. "type": "integer"
  464. },
  465. "signremark": {
  466. "description": "签署备注",
  467. "type": "string"
  468. },
  469. "signurl": {
  470. "description": "合同签署URL(三方URL)",
  471. "type": "string"
  472. },
  473. "templateconfigid": {
  474. "description": "模板配置ID",
  475. "type": "integer"
  476. },
  477. "templatename": {
  478. "description": "模板名称",
  479. "type": "string"
  480. },
  481. "templateno": {
  482. "description": "模板编号(电子签类型对应的模板编号)",
  483. "type": "string"
  484. },
  485. "templatetype": {
  486. "description": "模板类型 - 1:实名认证 2:开户协议",
  487. "type": "integer"
  488. },
  489. "updatetime": {
  490. "description": "更新时间",
  491. "type": "string"
  492. },
  493. "userid": {
  494. "description": "用户ID",
  495. "type": "integer"
  496. }
  497. }
  498. },
  499. "request.AddUserReq": {
  500. "type": "object",
  501. "required": [
  502. "idCard",
  503. "name"
  504. ],
  505. "properties": {
  506. "idCard": {
  507. "description": "证件号码",
  508. "type": "string"
  509. },
  510. "idCardPhoto": {
  511. "description": "证件照正面",
  512. "type": "string"
  513. },
  514. "idCardPhotoBackURL": {
  515. "description": "证件照背面",
  516. "type": "string"
  517. },
  518. "idCardType": {
  519. "description": "证件类型(默认1):1-居民身份证 2-台湾居民来往内地通行证 3-港澳居民往来内地通行证 10-武装警察身份证 11-军人身份证 15-警察(警官)证 21-外国人永久居留证 23-护照",
  520. "type": "integer"
  521. },
  522. "mobile": {
  523. "description": "手机号码",
  524. "type": "string"
  525. },
  526. "name": {
  527. "description": "用户姓名",
  528. "type": "string"
  529. }
  530. }
  531. },
  532. "request.CreateContractAndAddSignerReq": {
  533. "type": "object",
  534. "required": [
  535. "templateNo"
  536. ],
  537. "properties": {
  538. "templateNo": {
  539. "description": "合同模板编号",
  540. "type": "string"
  541. }
  542. }
  543. },
  544. "request.LoginReq": {
  545. "type": "object",
  546. "required": [
  547. "clientType",
  548. "password",
  549. "userName"
  550. ],
  551. "properties": {
  552. "clientType": {
  553. "description": "客户端类型,2-PC交易端 3-手机客户端_安卓 4-网页客户端 5-微信客户端 6-手机客户端_苹果",
  554. "type": "integer"
  555. },
  556. "password": {
  557. "description": "密码",
  558. "type": "string"
  559. },
  560. "userName": {
  561. "description": "用户名,可以是LoginID/LoginCode/手机号码",
  562. "type": "string"
  563. }
  564. }
  565. },
  566. "request.MQBodyReq": {
  567. "type": "object",
  568. "required": [
  569. "data",
  570. "funCodeReq",
  571. "isEncrypted"
  572. ],
  573. "properties": {
  574. "data": {
  575. "description": "请求数据",
  576. "type": "string"
  577. },
  578. "funCodeReq": {
  579. "description": "请求功能码",
  580. "type": "integer"
  581. },
  582. "funCodeRsp": {
  583. "description": "回复功能码",
  584. "type": "integer"
  585. },
  586. "isEncrypted": {
  587. "description": "是否加密",
  588. "type": "boolean"
  589. }
  590. }
  591. },
  592. "request.MQNtfReq": {
  593. "type": "object",
  594. "required": [
  595. "data",
  596. "funCode"
  597. ],
  598. "properties": {
  599. "data": {
  600. "description": "数据",
  601. "type": "string"
  602. },
  603. "funCode": {
  604. "description": "功能码",
  605. "type": "integer"
  606. },
  607. "topic": {
  608. "description": "主题",
  609. "type": "string"
  610. }
  611. }
  612. },
  613. "response.LoginRsp": {
  614. "type": "object",
  615. "properties": {
  616. "expiresAt": {
  617. "description": "过期时间",
  618. "type": "integer"
  619. },
  620. "loginId": {
  621. "description": "登录ID",
  622. "type": "integer"
  623. },
  624. "token": {
  625. "description": "新服务Token",
  626. "type": "string"
  627. },
  628. "userId": {
  629. "description": "用户ID",
  630. "type": "integer"
  631. }
  632. }
  633. },
  634. "response.MQBodyRsp": {
  635. "type": "object",
  636. "properties": {
  637. "data": {
  638. "description": "请求数据",
  639. "type": "string"
  640. },
  641. "funcode": {
  642. "description": "回复功能码",
  643. "type": "integer"
  644. },
  645. "isEncrypted": {
  646. "description": "是否加密",
  647. "type": "boolean"
  648. }
  649. }
  650. },
  651. "response.Response": {
  652. "type": "object",
  653. "properties": {
  654. "code": {
  655. "type": "integer"
  656. },
  657. "data": {},
  658. "msg": {
  659. "type": "string"
  660. }
  661. }
  662. }
  663. },
  664. "securityDefinitions": {
  665. "ApiKeyAuth": {
  666. "type": "apiKey",
  667. "name": "x-token",
  668. "in": "header"
  669. }
  670. }
  671. }`
  672. // SwaggerInfo holds exported Swagger Info so clients can modify it
  673. var SwaggerInfo = &swag.Spec{
  674. Version: "0.0.1",
  675. Host: "",
  676. BasePath: "",
  677. Schemes: []string{},
  678. Title: "Swagger Example API",
  679. Description: "新接入服务",
  680. InfoInstanceName: "swagger",
  681. SwaggerTemplate: docTemplate,
  682. }
  683. func init() {
  684. swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
  685. }