swagger.yaml 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436
  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. data:
  243. type: string
  244. msg:
  245. type: string
  246. type: object
  247. security:
  248. - ApiKeyAuth: []
  249. summary: 上传待签署文件和添加签署方
  250. tags:
  251. - 账户服务
  252. /Account/Login:
  253. post:
  254. consumes:
  255. - application/json
  256. parameters:
  257. - description: 登录入参
  258. in: body
  259. name: data
  260. required: true
  261. schema:
  262. $ref: '#/definitions/request.LoginReq'
  263. produces:
  264. - application/json
  265. responses:
  266. "200":
  267. description: 返回包括用户信息,token,过期时间
  268. schema:
  269. allOf:
  270. - $ref: '#/definitions/response.Response'
  271. - properties:
  272. data:
  273. $ref: '#/definitions/response.LoginRsp'
  274. msg:
  275. type: string
  276. type: object
  277. summary: 账户登录
  278. tags:
  279. - 账户服务
  280. /Account/Loginout:
  281. get:
  282. consumes:
  283. - application/json
  284. produces:
  285. - application/json
  286. responses:
  287. "200":
  288. description: 出参
  289. schema:
  290. allOf:
  291. - $ref: '#/definitions/response.Response'
  292. - properties:
  293. msg:
  294. type: string
  295. type: object
  296. security:
  297. - ApiKeyAuth: []
  298. summary: 用户登出请求
  299. tags:
  300. - 账户服务
  301. /Account/QueryUserESignRecord:
  302. get:
  303. consumes:
  304. - application/json
  305. produces:
  306. - application/json
  307. responses:
  308. "200":
  309. description: 出参
  310. schema:
  311. allOf:
  312. - $ref: '#/definitions/response.Response'
  313. - properties:
  314. data:
  315. items:
  316. $ref: '#/definitions/account.Useresignrecord'
  317. type: array
  318. msg:
  319. type: string
  320. type: object
  321. security:
  322. - ApiKeyAuth: []
  323. summary: 查询用户电子签记录表
  324. tags:
  325. - 账户服务
  326. /Account/TokenCheck:
  327. get:
  328. consumes:
  329. - application/json
  330. produces:
  331. - application/json
  332. responses:
  333. "200":
  334. description: 操作成功
  335. schema:
  336. allOf:
  337. - $ref: '#/definitions/response.Response'
  338. - properties:
  339. msg:
  340. type: string
  341. type: object
  342. security:
  343. - ApiKeyAuth: []
  344. summary: Token校验
  345. tags:
  346. - 账户服务
  347. /MQ/SendMsgToMQ:
  348. post:
  349. consumes:
  350. - application/json
  351. parameters:
  352. - description: 入参
  353. in: body
  354. name: data
  355. required: true
  356. schema:
  357. $ref: '#/definitions/request.MQBodyReq'
  358. produces:
  359. - application/json
  360. responses:
  361. "200":
  362. description: 出参
  363. schema:
  364. allOf:
  365. - $ref: '#/definitions/response.Response'
  366. - properties:
  367. data:
  368. $ref: '#/definitions/response.MQBodyRsp'
  369. msg:
  370. type: string
  371. type: object
  372. security:
  373. - ApiKeyAuth: []
  374. summary: 总线业务
  375. tags:
  376. - 总线业务
  377. /MQ/SendNtfToMQ:
  378. post:
  379. consumes:
  380. - application/json
  381. parameters:
  382. - description: 入参
  383. in: body
  384. name: data
  385. required: true
  386. schema:
  387. $ref: '#/definitions/request.MQNtfReq'
  388. produces:
  389. - application/json
  390. responses:
  391. "200":
  392. description: 出参
  393. schema:
  394. allOf:
  395. - $ref: '#/definitions/response.Response'
  396. - properties:
  397. msg:
  398. type: string
  399. type: object
  400. summary: 总线通知
  401. tags:
  402. - 总线业务
  403. /Quote/QuoteSubscribe:
  404. post:
  405. consumes:
  406. - application/json
  407. parameters:
  408. - description: 入参1
  409. in: body
  410. name: data
  411. required: true
  412. schema:
  413. $ref: '#/definitions/request.QuoteSubscribeReq'
  414. produces:
  415. - application/json
  416. responses:
  417. "200":
  418. description: 出参
  419. schema:
  420. allOf:
  421. - $ref: '#/definitions/response.Response'
  422. - properties:
  423. msg:
  424. type: string
  425. type: object
  426. security:
  427. - ApiKeyAuth: []
  428. summary: 订阅商品实时行情请求
  429. tags:
  430. - 实时行情
  431. securityDefinitions:
  432. ApiKeyAuth:
  433. in: header
  434. name: x-token
  435. type: apiKey
  436. swagger: "2.0"