swagger.yaml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434
  1. definitions:
  2. account.Useresignrecord:
  3. properties:
  4. authinfo:
  5. description: 认证信息
  6. type: string
  7. contractfileaddr:
  8. description: 合同签署文件地址
  9. type: string
  10. contractno:
  11. description: 合同编号
  12. type: string
  13. createtime:
  14. description: 创建时间
  15. type: string
  16. creatorid:
  17. description: 创建人
  18. type: integer
  19. orderindex:
  20. description: 显示顺序
  21. type: integer
  22. recordid:
  23. description: 记录ID(SEQ_USERESIGNRECORD)
  24. type: integer
  25. recordstatus:
  26. description: 记录状态 - 1:未签署 2:签署中 3:已签署 4:签署拒绝
  27. type: integer
  28. signremark:
  29. description: 签署备注
  30. type: string
  31. signurl:
  32. description: 合同签署URL(三方URL)
  33. type: string
  34. templateconfigid:
  35. description: 模板配置ID
  36. type: integer
  37. templatename:
  38. description: 模板名称
  39. type: string
  40. templateno:
  41. description: 模板编号(电子签类型对应的模板编号)
  42. type: string
  43. templatetype:
  44. description: 模板类型 - 1:实名认证 2:开户协议
  45. type: integer
  46. updatetime:
  47. description: 更新时间
  48. type: string
  49. userid:
  50. description: 用户ID
  51. type: integer
  52. type: object
  53. request.AddUserReq:
  54. properties:
  55. idCard:
  56. description: 证件号码
  57. type: string
  58. idCardPhoto:
  59. description: 证件照正面
  60. type: string
  61. idCardPhotoBackURL:
  62. description: 证件照背面
  63. type: string
  64. idCardType:
  65. description: 证件类型(默认1):1-居民身份证 2-台湾居民来往内地通行证 3-港澳居民往来内地通行证 10-武装警察身份证 11-军人身份证
  66. 15-警察(警官)证 21-外国人永久居留证 23-护照
  67. type: integer
  68. mobile:
  69. description: 手机号码
  70. type: string
  71. name:
  72. description: 用户姓名
  73. type: string
  74. required:
  75. - idCard
  76. - name
  77. type: object
  78. request.CreateContractAndAddSignerReq:
  79. properties:
  80. templateNo:
  81. description: 合同模板编号
  82. type: string
  83. required:
  84. - templateNo
  85. type: object
  86. request.LoginReq:
  87. properties:
  88. clientType:
  89. description: 客户端类型,2-PC交易端 3-手机客户端_安卓 4-网页客户端 5-微信客户端 6-手机客户端_苹果
  90. type: integer
  91. password:
  92. description: 密码
  93. type: string
  94. userName:
  95. description: 用户名,可以是LoginID/LoginCode/手机号码
  96. type: string
  97. required:
  98. - clientType
  99. - password
  100. - userName
  101. type: object
  102. request.MQBodyReq:
  103. properties:
  104. data:
  105. description: 请求数据
  106. type: string
  107. funCodeReq:
  108. description: 请求功能码
  109. type: integer
  110. funCodeRsp:
  111. description: 回复功能码
  112. type: integer
  113. isEncrypted:
  114. description: 是否加密
  115. type: boolean
  116. required:
  117. - data
  118. - funCodeReq
  119. - isEncrypted
  120. type: object
  121. request.MQNtfReq:
  122. properties:
  123. data:
  124. description: 数据
  125. type: string
  126. funCode:
  127. description: 功能码
  128. type: integer
  129. topic:
  130. description: 主题
  131. type: string
  132. required:
  133. - data
  134. - funCode
  135. type: object
  136. request.QuoteGoods:
  137. properties:
  138. exchangeId:
  139. description: 交易所代码,一般写死250
  140. type: integer
  141. goodsCode:
  142. description: 商品代码,全大写
  143. type: string
  144. type: object
  145. request.QuoteSubscribeReq:
  146. properties:
  147. quoteGoodses:
  148. description: 待订阅商品信息
  149. items:
  150. $ref: '#/definitions/request.QuoteGoods'
  151. type: array
  152. type: object
  153. response.LoginRsp:
  154. properties:
  155. expiresAt:
  156. description: 过期时间
  157. type: integer
  158. loginId:
  159. description: 登录ID
  160. type: integer
  161. token:
  162. description: 新服务Token
  163. type: string
  164. userId:
  165. description: 用户ID
  166. type: integer
  167. type: object
  168. response.MQBodyRsp:
  169. properties:
  170. data:
  171. description: 请求数据
  172. type: string
  173. funcode:
  174. description: 回复功能码
  175. type: integer
  176. isEncrypted:
  177. description: 是否加密
  178. type: boolean
  179. type: object
  180. response.Response:
  181. properties:
  182. code:
  183. type: integer
  184. data: {}
  185. msg:
  186. type: string
  187. type: object
  188. info:
  189. contact: {}
  190. description: 新接入服务
  191. title: Swagger Example API
  192. version: 0.0.1
  193. paths:
  194. /Account/AddUser:
  195. post:
  196. consumes:
  197. - application/json
  198. parameters:
  199. - description: 入参
  200. in: body
  201. name: data
  202. required: true
  203. schema:
  204. $ref: '#/definitions/request.AddUserReq'
  205. produces:
  206. - application/json
  207. responses:
  208. "200":
  209. description: 出参
  210. schema:
  211. allOf:
  212. - $ref: '#/definitions/response.Response'
  213. - properties:
  214. msg:
  215. type: string
  216. type: object
  217. security:
  218. - ApiKeyAuth: []
  219. summary: 实名认证添加用户
  220. tags:
  221. - 账户服务
  222. /Account/CreateContractAndAddSigner:
  223. post:
  224. consumes:
  225. - application/json
  226. parameters:
  227. - description: 入参
  228. in: body
  229. name: data
  230. required: true
  231. schema:
  232. $ref: '#/definitions/request.CreateContractAndAddSignerReq'
  233. produces:
  234. - application/json
  235. responses:
  236. "200":
  237. description: 出参
  238. schema:
  239. allOf:
  240. - $ref: '#/definitions/response.Response'
  241. - properties:
  242. msg:
  243. type: string
  244. type: object
  245. security:
  246. - ApiKeyAuth: []
  247. summary: 上传待签署文件和添加签署方
  248. tags:
  249. - 账户服务
  250. /Account/Login:
  251. post:
  252. consumes:
  253. - application/json
  254. parameters:
  255. - description: 登录入参
  256. in: body
  257. name: data
  258. required: true
  259. schema:
  260. $ref: '#/definitions/request.LoginReq'
  261. produces:
  262. - application/json
  263. responses:
  264. "200":
  265. description: 返回包括用户信息,token,过期时间
  266. schema:
  267. allOf:
  268. - $ref: '#/definitions/response.Response'
  269. - properties:
  270. data:
  271. $ref: '#/definitions/response.LoginRsp'
  272. msg:
  273. type: string
  274. type: object
  275. summary: 账户登录
  276. tags:
  277. - 账户服务
  278. /Account/Loginout:
  279. get:
  280. consumes:
  281. - application/json
  282. produces:
  283. - application/json
  284. responses:
  285. "200":
  286. description: 出参
  287. schema:
  288. allOf:
  289. - $ref: '#/definitions/response.Response'
  290. - properties:
  291. msg:
  292. type: string
  293. type: object
  294. security:
  295. - ApiKeyAuth: []
  296. summary: 用户登出请求
  297. tags:
  298. - 账户服务
  299. /Account/QueryUserESignRecord:
  300. get:
  301. consumes:
  302. - application/json
  303. produces:
  304. - application/json
  305. responses:
  306. "200":
  307. description: 出参
  308. schema:
  309. allOf:
  310. - $ref: '#/definitions/response.Response'
  311. - properties:
  312. data:
  313. items:
  314. $ref: '#/definitions/account.Useresignrecord'
  315. type: array
  316. msg:
  317. type: string
  318. type: object
  319. security:
  320. - ApiKeyAuth: []
  321. summary: 查询用户电子签记录表
  322. tags:
  323. - 账户服务
  324. /Account/TokenCheck:
  325. get:
  326. consumes:
  327. - application/json
  328. produces:
  329. - application/json
  330. responses:
  331. "200":
  332. description: 操作成功
  333. schema:
  334. allOf:
  335. - $ref: '#/definitions/response.Response'
  336. - properties:
  337. msg:
  338. type: string
  339. type: object
  340. security:
  341. - ApiKeyAuth: []
  342. summary: Token校验
  343. tags:
  344. - 账户服务
  345. /MQ/SendMsgToMQ:
  346. post:
  347. consumes:
  348. - application/json
  349. parameters:
  350. - description: 入参
  351. in: body
  352. name: data
  353. required: true
  354. schema:
  355. $ref: '#/definitions/request.MQBodyReq'
  356. produces:
  357. - application/json
  358. responses:
  359. "200":
  360. description: 出参
  361. schema:
  362. allOf:
  363. - $ref: '#/definitions/response.Response'
  364. - properties:
  365. data:
  366. $ref: '#/definitions/response.MQBodyRsp'
  367. msg:
  368. type: string
  369. type: object
  370. security:
  371. - ApiKeyAuth: []
  372. summary: 总线业务
  373. tags:
  374. - 总线业务
  375. /MQ/SendNtfToMQ:
  376. post:
  377. consumes:
  378. - application/json
  379. parameters:
  380. - description: 入参
  381. in: body
  382. name: data
  383. required: true
  384. schema:
  385. $ref: '#/definitions/request.MQNtfReq'
  386. produces:
  387. - application/json
  388. responses:
  389. "200":
  390. description: 出参
  391. schema:
  392. allOf:
  393. - $ref: '#/definitions/response.Response'
  394. - properties:
  395. msg:
  396. type: string
  397. type: object
  398. summary: 总线通知
  399. tags:
  400. - 总线业务
  401. /Quote/QuoteSubscribe:
  402. post:
  403. consumes:
  404. - application/json
  405. parameters:
  406. - description: 入参1
  407. in: body
  408. name: data
  409. required: true
  410. schema:
  411. $ref: '#/definitions/request.QuoteSubscribeReq'
  412. produces:
  413. - application/json
  414. responses:
  415. "200":
  416. description: 出参
  417. schema:
  418. allOf:
  419. - $ref: '#/definitions/response.Response'
  420. - properties:
  421. msg:
  422. type: string
  423. type: object
  424. security:
  425. - ApiKeyAuth: []
  426. summary: 订阅商品实时行情请求
  427. tags:
  428. - 实时行情
  429. securityDefinitions:
  430. ApiKeyAuth:
  431. in: header
  432. name: x-token
  433. type: apiKey
  434. swagger: "2.0"