00.yaml 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490
  1. ## Autogenerated by Scribe. DO NOT MODIFY.
  2. name: Endpoints
  3. description: ''
  4. endpoints:
  5. -
  6. httpMethods:
  7. - GET
  8. uri: 'api/scribe/update-token/{mobile}'
  9. metadata:
  10. groupName: Endpoints
  11. groupDescription: ''
  12. subgroup: ''
  13. subgroupDescription: ''
  14. title: 更新API文档的认证Token
  15. description: 通过手机号获取验证码并登录,然后更新API文档的认证Token
  16. authenticated: true
  17. custom: []
  18. headers:
  19. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  20. urlParameters:
  21. mobile:
  22. name: mobile
  23. description: 手机号码.
  24. required: true
  25. example: '13800138000'
  26. type: string
  27. enumValues: []
  28. exampleWasSpecified: true
  29. nullable: false
  30. custom: []
  31. cleanUrlParameters:
  32. mobile: '13800138000'
  33. queryParameters: []
  34. cleanQueryParameters: []
  35. bodyParameters: []
  36. cleanBodyParameters: []
  37. fileParameters: []
  38. responses:
  39. -
  40. status: 200
  41. content: |-
  42. {
  43. "code": 200,
  44. "message": "Token更新成功",
  45. "data": {
  46. "token": "your_new_token_here"
  47. }
  48. }
  49. headers: []
  50. description: ''
  51. custom: []
  52. responseFields: []
  53. auth:
  54. - headers
  55. - Authorization
  56. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  57. controller: null
  58. method: null
  59. route: null
  60. custom: []
  61. -
  62. httpMethods:
  63. - POST
  64. uri: api/account/send-code
  65. metadata:
  66. groupName: Endpoints
  67. groupDescription: ''
  68. subgroup: ''
  69. subgroupDescription: ''
  70. title: '[账户管理] 发送验证码'
  71. description: 向指定手机号发送验证码
  72. authenticated: true
  73. custom: []
  74. headers:
  75. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  76. Content-Type: application/json
  77. urlParameters: []
  78. cleanUrlParameters: []
  79. queryParameters: []
  80. cleanQueryParameters: []
  81. bodyParameters:
  82. mobile:
  83. name: mobile
  84. description: 手机号码.
  85. required: true
  86. example: '13800138000'
  87. type: string
  88. enumValues: []
  89. exampleWasSpecified: true
  90. nullable: false
  91. custom: []
  92. cleanBodyParameters:
  93. mobile: '13800138000'
  94. fileParameters: []
  95. responses:
  96. -
  97. status: 200
  98. content: |-
  99. {
  100. "code": 200,
  101. "message": "验证码发送成功",
  102. "data": null
  103. }
  104. headers: []
  105. description: ''
  106. custom: []
  107. responseFields: []
  108. auth:
  109. - headers
  110. - Authorization
  111. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  112. controller: null
  113. method: null
  114. route: null
  115. custom: []
  116. -
  117. httpMethods:
  118. - POST
  119. uri: api/account/login
  120. metadata:
  121. groupName: Endpoints
  122. groupDescription: ''
  123. subgroup: ''
  124. subgroupDescription: ''
  125. title: '[账户管理] 用户登录'
  126. description: 使用手机号和验证码登录账户
  127. authenticated: true
  128. custom: []
  129. headers:
  130. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  131. Content-Type: application/json
  132. urlParameters: []
  133. cleanUrlParameters: []
  134. queryParameters: []
  135. cleanQueryParameters: []
  136. bodyParameters:
  137. mobile:
  138. name: mobile
  139. description: 手机号码.
  140. required: true
  141. example: '13800138000'
  142. type: string
  143. enumValues: []
  144. exampleWasSpecified: true
  145. nullable: false
  146. custom: []
  147. code:
  148. name: code
  149. description: 验证码.
  150. required: true
  151. example: '123456'
  152. type: string
  153. enumValues: []
  154. exampleWasSpecified: true
  155. nullable: false
  156. custom: []
  157. cleanBodyParameters:
  158. mobile: '13800138000'
  159. code: '123456'
  160. fileParameters: []
  161. responses:
  162. -
  163. status: 200
  164. content: |-
  165. {
  166. "code": 200,
  167. "message": "登录成功",
  168. "data": {
  169. "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  170. "user": {
  171. "id": 1,
  172. "mobile": "13800138000",
  173. "nickname": "用户昵称"
  174. }
  175. }
  176. }
  177. headers: []
  178. description: ''
  179. custom: []
  180. responseFields: []
  181. auth:
  182. - headers
  183. - Authorization
  184. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  185. controller: null
  186. method: null
  187. route: null
  188. custom: []
  189. -
  190. httpMethods:
  191. - POST
  192. uri: api/account/wx-login
  193. metadata:
  194. groupName: Endpoints
  195. groupDescription: ''
  196. subgroup: ''
  197. subgroupDescription: ''
  198. title: '[账户管理] 微信登录'
  199. description: 使用微信openid登录账户
  200. authenticated: true
  201. custom: []
  202. headers:
  203. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  204. Content-Type: application/json
  205. urlParameters: []
  206. cleanUrlParameters: []
  207. queryParameters: []
  208. cleanQueryParameters: []
  209. bodyParameters:
  210. openid:
  211. name: openid
  212. description: 微信openid.
  213. required: true
  214. example: wx_123456789
  215. type: string
  216. enumValues: []
  217. exampleWasSpecified: true
  218. nullable: false
  219. custom: []
  220. cleanBodyParameters:
  221. openid: wx_123456789
  222. fileParameters: []
  223. responses:
  224. -
  225. status: 200
  226. content: |-
  227. {
  228. "code": 200,
  229. "message": "登录成功",
  230. "data": {
  231. "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  232. "user": {
  233. "id": 1,
  234. "openid": "wx_123456789",
  235. "nickname": "微信昵称"
  236. }
  237. }
  238. }
  239. headers: []
  240. description: ''
  241. custom: []
  242. responseFields: []
  243. auth:
  244. - headers
  245. - Authorization
  246. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  247. controller: null
  248. method: null
  249. route: null
  250. custom: []
  251. -
  252. httpMethods:
  253. - POST
  254. uri: api/account/logout
  255. metadata:
  256. groupName: Endpoints
  257. groupDescription: ''
  258. subgroup: ''
  259. subgroupDescription: ''
  260. title: '[账户管理] 用户退出'
  261. description: 退出当前账户登录状态
  262. authenticated: true
  263. custom: []
  264. headers:
  265. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  266. urlParameters: []
  267. cleanUrlParameters: []
  268. queryParameters: []
  269. cleanQueryParameters: []
  270. bodyParameters: []
  271. cleanBodyParameters: []
  272. fileParameters: []
  273. responses:
  274. -
  275. status: 200
  276. content: |-
  277. {
  278. "code": 200,
  279. "message": "退出成功",
  280. "data": null
  281. }
  282. headers: []
  283. description: ''
  284. custom: []
  285. responseFields: []
  286. auth:
  287. - headers
  288. - Authorization
  289. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  290. controller: null
  291. method: null
  292. route: null
  293. custom: []
  294. -
  295. httpMethods:
  296. - DELETE
  297. uri: api/account
  298. metadata:
  299. groupName: Endpoints
  300. groupDescription: ''
  301. subgroup: ''
  302. subgroupDescription: ''
  303. title: '[账户管理] 用户注销'
  304. description: 永久注销当前账户
  305. authenticated: true
  306. custom: []
  307. headers:
  308. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  309. urlParameters: []
  310. cleanUrlParameters: []
  311. queryParameters: []
  312. cleanQueryParameters: []
  313. bodyParameters: []
  314. cleanBodyParameters: []
  315. fileParameters: []
  316. responses:
  317. -
  318. status: 200
  319. content: |-
  320. {
  321. "code": 200,
  322. "message": "注销成功",
  323. "data": null
  324. }
  325. headers: []
  326. description: ''
  327. custom: []
  328. responseFields: []
  329. auth:
  330. - headers
  331. - Authorization
  332. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  333. controller: null
  334. method: null
  335. route: null
  336. custom: []
  337. -
  338. httpMethods:
  339. - POST
  340. uri: api/user/withdraw
  341. metadata:
  342. groupName: Endpoints
  343. groupDescription: ''
  344. subgroup: ''
  345. subgroupDescription: ''
  346. title: '[用户管理] 用户提现'
  347. description: 提现用户的余额
  348. authenticated: true
  349. custom: []
  350. headers:
  351. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  352. Content-Type: application/json
  353. urlParameters: []
  354. cleanUrlParameters: []
  355. queryParameters: []
  356. cleanQueryParameters: []
  357. bodyParameters:
  358. amount:
  359. name: amount
  360. description: 提现金额.
  361. required: false
  362. example: '100.00'
  363. type: decimal
  364. enumValues: []
  365. exampleWasSpecified: true
  366. nullable: false
  367. custom: []
  368. cleanBodyParameters:
  369. amount: '100.00'
  370. fileParameters: []
  371. responses:
  372. -
  373. status: 200
  374. content: |-
  375. {
  376. "code": 200,
  377. "message": "提现成功",
  378. "data": null
  379. }
  380. headers: []
  381. description: ''
  382. custom: []
  383. responseFields: []
  384. auth:
  385. - headers
  386. - Authorization
  387. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  388. controller: null
  389. method: null
  390. route: null
  391. custom: []
  392. -
  393. httpMethods:
  394. - POST
  395. uri: api/user/feedback
  396. metadata:
  397. groupName: Endpoints
  398. groupDescription: ''
  399. subgroup: ''
  400. subgroupDescription: ''
  401. title: '[用户管理] 用户反馈'
  402. description: 提交用户的反馈信息
  403. authenticated: true
  404. custom: []
  405. headers:
  406. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  407. Content-Type: application/json
  408. urlParameters: []
  409. cleanUrlParameters: []
  410. queryParameters: []
  411. cleanQueryParameters: []
  412. bodyParameters:
  413. content:
  414. name: content
  415. description: 反馈内容.
  416. required: false
  417. example: 这是一个反馈信息
  418. type: string
  419. enumValues: []
  420. exampleWasSpecified: true
  421. nullable: false
  422. custom: []
  423. cleanBodyParameters:
  424. content: 这是一个反馈信息
  425. fileParameters: []
  426. responses:
  427. -
  428. status: 200
  429. content: |-
  430. {
  431. "code": 200,
  432. "message": "提交成功",
  433. "data": null
  434. }
  435. headers: []
  436. description: ''
  437. custom: []
  438. responseFields: []
  439. auth:
  440. - headers
  441. - Authorization
  442. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  443. controller: null
  444. method: null
  445. route: null
  446. custom: []
  447. -
  448. httpMethods:
  449. - POST
  450. uri: api/user/apply-coach
  451. metadata:
  452. groupName: Endpoints
  453. groupDescription: ''
  454. subgroup: ''
  455. subgroupDescription: ''
  456. title: '[用户管理] 申请成为技师'
  457. description: 申请成为技师
  458. authenticated: true
  459. custom: []
  460. headers:
  461. Authorization: 'Bearer 68|ynrtTr0JPkmVmV80Cd0o2PIapOZk8mA3xDWnpqt1b3045d50'
  462. urlParameters: []
  463. cleanUrlParameters: []
  464. queryParameters: []
  465. cleanQueryParameters: []
  466. bodyParameters: []
  467. cleanBodyParameters: []
  468. fileParameters: []
  469. responses:
  470. -
  471. status: 200
  472. content: |-
  473. {
  474. "code": 200,
  475. "message": "申请成功",
  476. "data": null
  477. }
  478. headers: []
  479. description: ''
  480. custom: []
  481. responseFields: []
  482. auth:
  483. - headers
  484. - Authorization
  485. - 'Bearer Bearer {YOUR_AUTH_KEY}'
  486. controller: null
  487. method: null
  488. route: null
  489. custom: []