docs.go 25 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759
  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. "/Account/WillFace": {
  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.WillFaceReq"
  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. "type": "string"
  371. },
  372. "msg": {
  373. "type": "string"
  374. }
  375. }
  376. }
  377. ]
  378. }
  379. }
  380. }
  381. }
  382. },
  383. "/MQ/SendMsgToMQ": {
  384. "post": {
  385. "security": [
  386. {
  387. "ApiKeyAuth": []
  388. }
  389. ],
  390. "consumes": [
  391. "application/json"
  392. ],
  393. "produces": [
  394. "application/json"
  395. ],
  396. "tags": [
  397. "总线业务"
  398. ],
  399. "summary": "总线业务",
  400. "parameters": [
  401. {
  402. "description": "入参",
  403. "name": "data",
  404. "in": "body",
  405. "required": true,
  406. "schema": {
  407. "$ref": "#/definitions/request.MQBodyReq"
  408. }
  409. }
  410. ],
  411. "responses": {
  412. "200": {
  413. "description": "出参",
  414. "schema": {
  415. "allOf": [
  416. {
  417. "$ref": "#/definitions/response.Response"
  418. },
  419. {
  420. "type": "object",
  421. "properties": {
  422. "data": {
  423. "$ref": "#/definitions/response.MQBodyRsp"
  424. },
  425. "msg": {
  426. "type": "string"
  427. }
  428. }
  429. }
  430. ]
  431. }
  432. }
  433. }
  434. }
  435. },
  436. "/MQ/SendNtfToMQ": {
  437. "post": {
  438. "consumes": [
  439. "application/json"
  440. ],
  441. "produces": [
  442. "application/json"
  443. ],
  444. "tags": [
  445. "总线业务"
  446. ],
  447. "summary": "总线通知",
  448. "parameters": [
  449. {
  450. "description": "入参",
  451. "name": "data",
  452. "in": "body",
  453. "required": true,
  454. "schema": {
  455. "$ref": "#/definitions/request.MQNtfReq"
  456. }
  457. }
  458. ],
  459. "responses": {
  460. "200": {
  461. "description": "出参",
  462. "schema": {
  463. "allOf": [
  464. {
  465. "$ref": "#/definitions/response.Response"
  466. },
  467. {
  468. "type": "object",
  469. "properties": {
  470. "msg": {
  471. "type": "string"
  472. }
  473. }
  474. }
  475. ]
  476. }
  477. }
  478. }
  479. }
  480. }
  481. },
  482. "definitions": {
  483. "account.Useresignrecord": {
  484. "type": "object",
  485. "properties": {
  486. "authinfo": {
  487. "description": "认证信息",
  488. "type": "string"
  489. },
  490. "contractfileaddr": {
  491. "description": "合同签署文件地址",
  492. "type": "string"
  493. },
  494. "contractno": {
  495. "description": "合同编号",
  496. "type": "string"
  497. },
  498. "createtime": {
  499. "description": "创建时间",
  500. "type": "string"
  501. },
  502. "creatorid": {
  503. "description": "创建人",
  504. "type": "integer"
  505. },
  506. "orderindex": {
  507. "description": "显示顺序",
  508. "type": "integer"
  509. },
  510. "recordid": {
  511. "description": "记录ID(SEQ_USERESIGNRECORD)",
  512. "type": "integer"
  513. },
  514. "recordstatus": {
  515. "description": "记录状态 - 1:未签署 2:签署中 3:已签署 4:签署拒绝",
  516. "type": "integer"
  517. },
  518. "signremark": {
  519. "description": "签署备注",
  520. "type": "string"
  521. },
  522. "signurl": {
  523. "description": "合同签署URL(三方URL)",
  524. "type": "string"
  525. },
  526. "templateconfigid": {
  527. "description": "模板配置ID",
  528. "type": "integer"
  529. },
  530. "templatename": {
  531. "description": "模板名称",
  532. "type": "string"
  533. },
  534. "templateno": {
  535. "description": "模板编号(电子签类型对应的模板编号)",
  536. "type": "string"
  537. },
  538. "templatetype": {
  539. "description": "模板类型 - 1:实名认证 2:开户协议",
  540. "type": "integer"
  541. },
  542. "updatetime": {
  543. "description": "更新时间",
  544. "type": "string"
  545. },
  546. "userid": {
  547. "description": "用户ID",
  548. "type": "integer"
  549. }
  550. }
  551. },
  552. "request.AddUserReq": {
  553. "type": "object",
  554. "required": [
  555. "idCard",
  556. "name"
  557. ],
  558. "properties": {
  559. "idCard": {
  560. "description": "证件号码",
  561. "type": "string"
  562. },
  563. "idCardPhoto": {
  564. "description": "证件照正面",
  565. "type": "string"
  566. },
  567. "idCardPhotoBackURL": {
  568. "description": "证件照背面",
  569. "type": "string"
  570. },
  571. "idCardType": {
  572. "description": "证件类型(默认1):1-居民身份证 2-台湾居民来往内地通行证 3-港澳居民往来内地通行证 10-武装警察身份证 11-军人身份证 15-警察(警官)证 21-外国人永久居留证 23-护照",
  573. "type": "integer"
  574. },
  575. "mobile": {
  576. "description": "手机号码",
  577. "type": "string"
  578. },
  579. "name": {
  580. "description": "用户姓名",
  581. "type": "string"
  582. }
  583. }
  584. },
  585. "request.CreateContractAndAddSignerReq": {
  586. "type": "object",
  587. "required": [
  588. "templateNo"
  589. ],
  590. "properties": {
  591. "templateNo": {
  592. "description": "合同模板编号",
  593. "type": "string"
  594. }
  595. }
  596. },
  597. "request.LoginReq": {
  598. "type": "object",
  599. "required": [
  600. "clientType",
  601. "password",
  602. "userName"
  603. ],
  604. "properties": {
  605. "clientType": {
  606. "description": "客户端类型,2-PC交易端 3-手机客户端_安卓 4-网页客户端 5-微信客户端 6-手机客户端_苹果",
  607. "type": "integer"
  608. },
  609. "password": {
  610. "description": "密码",
  611. "type": "string"
  612. },
  613. "userName": {
  614. "description": "用户名,可以是LoginID/LoginCode/手机号码",
  615. "type": "string"
  616. }
  617. }
  618. },
  619. "request.MQBodyReq": {
  620. "type": "object",
  621. "required": [
  622. "data",
  623. "funCodeReq",
  624. "isEncrypted"
  625. ],
  626. "properties": {
  627. "data": {
  628. "description": "请求数据",
  629. "type": "string"
  630. },
  631. "funCodeReq": {
  632. "description": "请求功能码",
  633. "type": "integer"
  634. },
  635. "funCodeRsp": {
  636. "description": "回复功能码",
  637. "type": "integer"
  638. },
  639. "isEncrypted": {
  640. "description": "是否加密",
  641. "type": "boolean"
  642. }
  643. }
  644. },
  645. "request.MQNtfReq": {
  646. "type": "object",
  647. "required": [
  648. "data",
  649. "funCode"
  650. ],
  651. "properties": {
  652. "data": {
  653. "description": "数据",
  654. "type": "string"
  655. },
  656. "funCode": {
  657. "description": "功能码",
  658. "type": "integer"
  659. },
  660. "topic": {
  661. "description": "主题",
  662. "type": "string"
  663. }
  664. }
  665. },
  666. "request.WillFaceReq": {
  667. "type": "object",
  668. "required": [
  669. "idCardNo",
  670. "realName"
  671. ],
  672. "properties": {
  673. "idCardNo": {
  674. "description": "身份证号",
  675. "type": "string"
  676. },
  677. "realName": {
  678. "description": "真实姓名",
  679. "type": "string"
  680. }
  681. }
  682. },
  683. "response.LoginRsp": {
  684. "type": "object",
  685. "properties": {
  686. "expiresAt": {
  687. "description": "过期时间",
  688. "type": "integer"
  689. },
  690. "loginId": {
  691. "description": "登录ID",
  692. "type": "integer"
  693. },
  694. "token": {
  695. "description": "新服务Token",
  696. "type": "string"
  697. },
  698. "userId": {
  699. "description": "用户ID",
  700. "type": "integer"
  701. }
  702. }
  703. },
  704. "response.MQBodyRsp": {
  705. "type": "object",
  706. "properties": {
  707. "data": {
  708. "description": "请求数据",
  709. "type": "string"
  710. },
  711. "funcode": {
  712. "description": "回复功能码",
  713. "type": "integer"
  714. },
  715. "isEncrypted": {
  716. "description": "是否加密",
  717. "type": "boolean"
  718. }
  719. }
  720. },
  721. "response.Response": {
  722. "type": "object",
  723. "properties": {
  724. "code": {
  725. "type": "integer"
  726. },
  727. "data": {},
  728. "msg": {
  729. "type": "string"
  730. }
  731. }
  732. }
  733. },
  734. "securityDefinitions": {
  735. "ApiKeyAuth": {
  736. "type": "apiKey",
  737. "name": "x-token",
  738. "in": "header"
  739. }
  740. }
  741. }`
  742. // SwaggerInfo holds exported Swagger Info so clients can modify it
  743. var SwaggerInfo = &swag.Spec{
  744. Version: "0.0.1",
  745. Host: "",
  746. BasePath: "",
  747. Schemes: []string{},
  748. Title: "Swagger Example API",
  749. Description: "新接入服务",
  750. InfoInstanceName: "swagger",
  751. SwaggerTemplate: docTemplate,
  752. }
  753. func init() {
  754. swag.Register(SwaggerInfo.InstanceName(), SwaggerInfo)
  755. }