swagger.yaml 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  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.LoginReq:
  79. properties:
  80. clientType:
  81. description: 客户端类型,2-PC交易端 3-手机客户端_安卓 4-网页客户端 5-微信客户端 6-手机客户端_苹果
  82. type: integer
  83. password:
  84. description: 密码
  85. type: string
  86. userName:
  87. description: 用户名,可以是LoginID/LoginCode/手机号码
  88. type: string
  89. required:
  90. - clientType
  91. - password
  92. - userName
  93. type: object
  94. request.MQBodyReq:
  95. properties:
  96. data:
  97. description: 请求数据
  98. type: string
  99. funCodeReq:
  100. description: 请求功能码
  101. type: integer
  102. funCodeRsp:
  103. description: 回复功能码
  104. type: integer
  105. isEncrypted:
  106. description: 是否加密
  107. type: boolean
  108. required:
  109. - data
  110. - funCodeReq
  111. - isEncrypted
  112. type: object
  113. request.MQNtfReq:
  114. properties:
  115. data:
  116. description: 数据
  117. type: string
  118. funCode:
  119. description: 功能码
  120. type: integer
  121. topic:
  122. description: 主题
  123. type: string
  124. required:
  125. - data
  126. - funCode
  127. type: object
  128. request.QuoteGoods:
  129. properties:
  130. exchangeId:
  131. description: 交易所代码,一般写死250
  132. type: integer
  133. goodsCode:
  134. description: 商品代码,全大写
  135. type: string
  136. type: object
  137. request.QuoteSubscribeReq:
  138. properties:
  139. quoteGoodses:
  140. description: 待订阅商品信息
  141. items:
  142. $ref: '#/definitions/request.QuoteGoods'
  143. type: array
  144. type: object
  145. response.LoginRsp:
  146. properties:
  147. expiresAt:
  148. description: 过期时间
  149. type: integer
  150. loginId:
  151. description: 登录ID
  152. type: integer
  153. token:
  154. description: 新服务Token
  155. type: string
  156. userId:
  157. description: 用户ID
  158. type: integer
  159. type: object
  160. response.MQBodyRsp:
  161. properties:
  162. data:
  163. description: 请求数据
  164. type: string
  165. funcode:
  166. description: 回复功能码
  167. type: integer
  168. isEncrypted:
  169. description: 是否加密
  170. type: boolean
  171. type: object
  172. response.Response:
  173. properties:
  174. code:
  175. type: integer
  176. data: {}
  177. msg:
  178. type: string
  179. type: object
  180. info:
  181. contact: {}
  182. description: 新接入服务
  183. title: Swagger Example API
  184. version: 0.0.1
  185. paths:
  186. /Account/AddUser:
  187. post:
  188. consumes:
  189. - application/json
  190. parameters:
  191. - description: 入参
  192. in: body
  193. name: data
  194. required: true
  195. schema:
  196. $ref: '#/definitions/request.AddUserReq'
  197. produces:
  198. - application/json
  199. responses:
  200. "200":
  201. description: 出参
  202. schema:
  203. allOf:
  204. - $ref: '#/definitions/response.Response'
  205. - properties:
  206. msg:
  207. type: string
  208. type: object
  209. security:
  210. - ApiKeyAuth: []
  211. summary: 实名认证添加用户
  212. tags:
  213. - 账户服务
  214. /Account/Login:
  215. post:
  216. consumes:
  217. - application/json
  218. parameters:
  219. - description: 登录入参
  220. in: body
  221. name: data
  222. required: true
  223. schema:
  224. $ref: '#/definitions/request.LoginReq'
  225. produces:
  226. - application/json
  227. responses:
  228. "200":
  229. description: 返回包括用户信息,token,过期时间
  230. schema:
  231. allOf:
  232. - $ref: '#/definitions/response.Response'
  233. - properties:
  234. data:
  235. $ref: '#/definitions/response.LoginRsp'
  236. msg:
  237. type: string
  238. type: object
  239. summary: 账户登录
  240. tags:
  241. - 账户服务
  242. /Account/Loginout:
  243. get:
  244. consumes:
  245. - application/json
  246. produces:
  247. - application/json
  248. responses:
  249. "200":
  250. description: 出参
  251. schema:
  252. allOf:
  253. - $ref: '#/definitions/response.Response'
  254. - properties:
  255. msg:
  256. type: string
  257. type: object
  258. security:
  259. - ApiKeyAuth: []
  260. summary: 用户登出请求
  261. tags:
  262. - 账户服务
  263. /Account/QueryUserESignRecord:
  264. get:
  265. consumes:
  266. - application/json
  267. produces:
  268. - application/json
  269. responses:
  270. "200":
  271. description: 出参
  272. schema:
  273. allOf:
  274. - $ref: '#/definitions/response.Response'
  275. - properties:
  276. data:
  277. items:
  278. $ref: '#/definitions/account.Useresignrecord'
  279. type: array
  280. msg:
  281. type: string
  282. type: object
  283. security:
  284. - ApiKeyAuth: []
  285. summary: 查询用户电子签记录表
  286. tags:
  287. - 账户服务
  288. /Account/TokenCheck:
  289. get:
  290. consumes:
  291. - application/json
  292. produces:
  293. - application/json
  294. responses:
  295. "200":
  296. description: 操作成功
  297. schema:
  298. allOf:
  299. - $ref: '#/definitions/response.Response'
  300. - properties:
  301. msg:
  302. type: string
  303. type: object
  304. security:
  305. - ApiKeyAuth: []
  306. summary: Token校验
  307. tags:
  308. - 账户服务
  309. /MQ/SendMsgToMQ:
  310. post:
  311. consumes:
  312. - application/json
  313. parameters:
  314. - description: 入参
  315. in: body
  316. name: data
  317. required: true
  318. schema:
  319. $ref: '#/definitions/request.MQBodyReq'
  320. produces:
  321. - application/json
  322. responses:
  323. "200":
  324. description: 出参
  325. schema:
  326. allOf:
  327. - $ref: '#/definitions/response.Response'
  328. - properties:
  329. data:
  330. $ref: '#/definitions/response.MQBodyRsp'
  331. msg:
  332. type: string
  333. type: object
  334. security:
  335. - ApiKeyAuth: []
  336. summary: 总线业务
  337. tags:
  338. - 总线业务
  339. /MQ/SendNtfToMQ:
  340. post:
  341. consumes:
  342. - application/json
  343. parameters:
  344. - description: 入参
  345. in: body
  346. name: data
  347. required: true
  348. schema:
  349. $ref: '#/definitions/request.MQNtfReq'
  350. produces:
  351. - application/json
  352. responses:
  353. "200":
  354. description: 出参
  355. schema:
  356. allOf:
  357. - $ref: '#/definitions/response.Response'
  358. - properties:
  359. msg:
  360. type: string
  361. type: object
  362. summary: 总线通知
  363. tags:
  364. - 总线业务
  365. /Quote/QuoteSubscribe:
  366. post:
  367. consumes:
  368. - application/json
  369. parameters:
  370. - description: 入参1
  371. in: body
  372. name: data
  373. required: true
  374. schema:
  375. $ref: '#/definitions/request.QuoteSubscribeReq'
  376. produces:
  377. - application/json
  378. responses:
  379. "200":
  380. description: 出参
  381. schema:
  382. allOf:
  383. - $ref: '#/definitions/response.Response'
  384. - properties:
  385. msg:
  386. type: string
  387. type: object
  388. security:
  389. - ApiKeyAuth: []
  390. summary: 订阅商品实时行情请求
  391. tags:
  392. - 实时行情
  393. securityDefinitions:
  394. ApiKeyAuth:
  395. in: header
  396. name: x-token
  397. type: apiKey
  398. swagger: "2.0"