swagger.yaml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480
  1. definitions:
  2. models.BindMobileReq:
  3. properties:
  4. mobile:
  5. type: string
  6. user_code:
  7. type: string
  8. valid_code:
  9. type: string
  10. type: object
  11. models.EditCardReq:
  12. properties:
  13. card_back:
  14. type: string
  15. card_front:
  16. type: string
  17. card_id:
  18. type: string
  19. user_code:
  20. type: string
  21. type: object
  22. models.GetbackPwdReq:
  23. properties:
  24. mobile:
  25. type: string
  26. password:
  27. type: string
  28. valid_code:
  29. type: string
  30. type: object
  31. models.QuickLoginReq:
  32. properties:
  33. mobile:
  34. type: string
  35. valid_code:
  36. type: string
  37. type: object
  38. models.RegisterReq:
  39. properties:
  40. area:
  41. type: string
  42. birthday:
  43. type: string
  44. gender:
  45. type: integer
  46. mobile:
  47. type: string
  48. password:
  49. type: string
  50. user_name:
  51. type: string
  52. valid_code:
  53. type: string
  54. type: object
  55. models.SendSmsReq:
  56. properties:
  57. content:
  58. type: string
  59. mobile:
  60. type: string
  61. type: object
  62. models.ThirdLoginReq:
  63. properties:
  64. avatar:
  65. type: string
  66. open_id:
  67. type: string
  68. user_name:
  69. type: string
  70. type: object
  71. models.UpdateAvatarReq:
  72. properties:
  73. avatar:
  74. type: string
  75. user_code:
  76. type: string
  77. type: object
  78. models.UpdateProfileReq:
  79. properties:
  80. area:
  81. type: string
  82. birthday:
  83. type: string
  84. city:
  85. type: string
  86. gender:
  87. type: integer
  88. identify:
  89. type: string
  90. nickname:
  91. type: string
  92. province:
  93. type: string
  94. user_code:
  95. type: string
  96. user_height:
  97. type: integer
  98. user_weight:
  99. type: integer
  100. type: object
  101. models.UpdatePwdReq:
  102. properties:
  103. new_pwd:
  104. type: string
  105. old_pwd:
  106. type: string
  107. user_code:
  108. type: string
  109. type: object
  110. models.WxLoginReq:
  111. properties:
  112. mobile:
  113. type: string
  114. type: object
  115. info:
  116. contact: {}
  117. description: lzyd user server api
  118. license: {}
  119. title: lzyd user server api
  120. version: "1.0"
  121. paths:
  122. /app/launch:
  123. get:
  124. description: 获取App启动配置
  125. parameters:
  126. - description: 客户端标识 1=iOS 2=Android 3=小程序
  127. in: query
  128. name: client
  129. required: true
  130. type: integer
  131. produces:
  132. - application/json
  133. responses:
  134. "200":
  135. description: '{"code":200,"message":"success":"data":{}}'
  136. schema:
  137. type: string
  138. summary: 获取App启动配置
  139. tags:
  140. - Config
  141. /customer/editCard:
  142. post:
  143. description: 修改身份证信息
  144. parameters:
  145. - description: 修改身份证请求内容
  146. in: body
  147. name: body
  148. required: true
  149. schema:
  150. $ref: '#/definitions/models.EditCardReq'
  151. type: object
  152. produces:
  153. - application/json
  154. responses:
  155. "200":
  156. description: '{"code":200,"message":"success"}'
  157. schema:
  158. type: string
  159. summary: 修改身份证信息
  160. tags:
  161. - Customer
  162. /customer/getInfo:
  163. get:
  164. description: 获取用户详细信息
  165. parameters:
  166. - description: 用户ID
  167. in: query
  168. name: user_code
  169. required: true
  170. type: string
  171. produces:
  172. - application/json
  173. responses:
  174. "200":
  175. description: '{"code":200,"message":"success","data":{"token":"","customer":{"user_id":"","mobile_phone":"","user_name":"靓妆会员","avatar":"https://","gender":2,"birthday":"","area":"江苏省-南京市-鼓楼区","email":"","customer_level":0,"user_point":0,"user_money":0.00,"register_time":""}}}'
  176. schema:
  177. type: string
  178. summary: 获取用户详细信息
  179. tags:
  180. - Customer
  181. /customer/getPoints:
  182. get:
  183. description: 获取用户总积分
  184. parameters:
  185. - description: 用户ID
  186. in: query
  187. name: user_code
  188. required: true
  189. type: string
  190. produces:
  191. - application/json
  192. responses:
  193. "200":
  194. description: '{"code":200,"message":"success","data":{}}'
  195. schema:
  196. type: string
  197. summary: 获取用户总积分
  198. tags:
  199. - Customer
  200. /customer/updateAvatar:
  201. post:
  202. description: 修改用户的头像
  203. parameters:
  204. - description: 修改用户头像请求内容
  205. in: body
  206. name: body
  207. required: true
  208. schema:
  209. $ref: '#/definitions/models.UpdateAvatarReq'
  210. type: object
  211. produces:
  212. - application/json
  213. responses:
  214. "200":
  215. description: '{"code":200,"message":"success"}'
  216. schema:
  217. type: string
  218. summary: 修改用户的头像
  219. tags:
  220. - Customer
  221. /customer/updateProfile:
  222. post:
  223. description: 修改用户资料
  224. parameters:
  225. - description: 修改用户资料请求内容
  226. in: body
  227. name: body
  228. required: true
  229. schema:
  230. $ref: '#/definitions/models.UpdateProfileReq'
  231. type: object
  232. produces:
  233. - application/json
  234. responses:
  235. "200":
  236. description: '{"code":200,"message":"success","data":{}}'
  237. schema:
  238. type: string
  239. summary: 修改用户资料
  240. tags:
  241. - Customer
  242. /customer/updatePwd:
  243. post:
  244. description: 修改密码
  245. parameters:
  246. - description: 修改密码请求内容
  247. in: body
  248. name: body
  249. required: true
  250. schema:
  251. $ref: '#/definitions/models.UpdatePwdReq'
  252. type: object
  253. produces:
  254. - application/json
  255. responses:
  256. "200":
  257. description: '{"code":200,"message":"success"}'
  258. schema:
  259. type: string
  260. summary: 修改密码
  261. tags:
  262. - Customer
  263. /passport/bindMobile:
  264. post:
  265. consumes:
  266. - application/json
  267. description: 绑定手机号
  268. parameters:
  269. - description: 绑定手机号请求内容
  270. in: body
  271. name: body
  272. required: true
  273. schema:
  274. $ref: '#/definitions/models.BindMobileReq'
  275. type: object
  276. produces:
  277. - application/json
  278. responses:
  279. "200":
  280. description: '{"code":200,"message":"success"}'
  281. schema:
  282. type: string
  283. summary: 绑定手机号
  284. tags:
  285. - Passport
  286. /passport/getbackPwd:
  287. post:
  288. consumes:
  289. - application/json
  290. description: 密码找回
  291. parameters:
  292. - description: 密码找回请求内容
  293. in: body
  294. name: body
  295. required: true
  296. schema:
  297. $ref: '#/definitions/models.GetbackPwdReq'
  298. type: object
  299. produces:
  300. - application/json
  301. responses:
  302. "200":
  303. description: '{"code":200,"message":"success"}'
  304. schema:
  305. type: string
  306. summary: 密码找回
  307. tags:
  308. - Passport
  309. /passport/loginByThirdParty:
  310. post:
  311. consumes:
  312. - application/json
  313. description: 第三方登录
  314. parameters:
  315. - description: 第三方登录请求内容
  316. in: body
  317. name: body
  318. required: true
  319. schema:
  320. $ref: '#/definitions/models.ThirdLoginReq'
  321. type: object
  322. produces:
  323. - application/json
  324. responses:
  325. "200":
  326. description: '{"code":200,"message":"success","data":{}}'
  327. schema:
  328. type: string
  329. summary: 第三方登录
  330. tags:
  331. - Passport
  332. /passport/quickLogin:
  333. post:
  334. consumes:
  335. - application/json
  336. description: 快捷登录
  337. parameters:
  338. - description: 快捷登录请求内容
  339. in: body
  340. name: body
  341. required: true
  342. schema:
  343. $ref: '#/definitions/models.QuickLoginReq'
  344. type: object
  345. produces:
  346. - application/json
  347. responses:
  348. "200":
  349. description: '{"code":200,"message":"success","data":{"token":"","user":{}}}'
  350. schema:
  351. type: string
  352. summary: 快捷登录
  353. tags:
  354. - Passport
  355. /passport/register:
  356. post:
  357. consumes:
  358. - application/json
  359. description: 用户注册
  360. parameters:
  361. - description: 注册请求内容
  362. in: body
  363. name: body
  364. required: true
  365. schema:
  366. $ref: '#/definitions/models.RegisterReq'
  367. type: object
  368. produces:
  369. - application/json
  370. responses:
  371. "200":
  372. description: '{"code":200,"message":"success","data":{"token":"","user":{}}}'
  373. schema:
  374. type: string
  375. summary: 用户注册
  376. tags:
  377. - Passport
  378. /passport/wechatLogin:
  379. post:
  380. consumes:
  381. - application/json
  382. description: 微信手机号码登录
  383. parameters:
  384. - description: 微信手机登录请求内容
  385. in: body
  386. name: body
  387. required: true
  388. schema:
  389. $ref: '#/definitions/models.WxLoginReq'
  390. type: object
  391. produces:
  392. - application/json
  393. responses:
  394. "200":
  395. description: '{"code":200,"message":"success","data":{"token":"","user":{}}}'
  396. schema:
  397. type: string
  398. summary: 微信手机号码登录
  399. tags:
  400. - Passport
  401. /sms/get:
  402. get:
  403. description: 指定模板单发短信
  404. parameters:
  405. - description: 手机号码
  406. in: query
  407. name: mobile
  408. required: true
  409. type: string
  410. - default: 1
  411. description: 短信验证码类型(1=注册 2=找回密码 3=绑定手机号 4=快捷登录)
  412. enum:
  413. - 1
  414. - 2
  415. - 3
  416. - 4
  417. in: query
  418. name: type
  419. required: true
  420. type: integer
  421. produces:
  422. - application/json
  423. responses:
  424. "200":
  425. description: '{"code":200, "message":"success"}'
  426. schema:
  427. type: string
  428. summary: 指定模板单发短信
  429. tags:
  430. - Sms
  431. /sms/remind:
  432. post:
  433. consumes:
  434. - application/json
  435. description: 发送提醒短信
  436. parameters:
  437. - description: 短信请求内容
  438. in: body
  439. name: body
  440. required: true
  441. schema:
  442. $ref: '#/definitions/models.SendSmsReq'
  443. type: object
  444. produces:
  445. - application/json
  446. responses:
  447. "200":
  448. description: '{"code":200, "message":"success"}'
  449. schema:
  450. type: string
  451. summary: 发送提醒短信
  452. tags:
  453. - Sms
  454. /upload/image:
  455. post:
  456. consumes:
  457. - multipart/form-data
  458. description: 单图片上传接口, name=image
  459. parameters:
  460. - description: 上传者的用户ID
  461. in: formData
  462. name: user_code
  463. required: true
  464. type: string
  465. - description: 上传的图片
  466. in: formData
  467. name: image
  468. required: true
  469. type: file
  470. produces:
  471. - application/json
  472. responses:
  473. "200":
  474. description: '{"code":200,"message":"success","data":"http://image.bitekun.xin/images/2019-03/test.png"}'
  475. schema:
  476. type: string
  477. summary: 图片上传
  478. tags:
  479. - Upload
  480. swagger: "2.0"