蛋蛋星球-客户端
您最多选择25个主题 主题必须以字母或数字开头,可以包含连字符 (-),并且长度不得超过35个字符

swagger.yaml 4.0 KiB

1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
1周前
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182
  1. basePath: /api/v1
  2. definitions:
  3. md.LoginReq:
  4. properties:
  5. code:
  6. example: 验证码
  7. type: string
  8. password:
  9. example: 登录密码
  10. type: string
  11. phone:
  12. example: 手机号
  13. type: string
  14. required:
  15. - password
  16. - phone
  17. type: object
  18. md.LoginResponse:
  19. properties:
  20. token:
  21. type: string
  22. type: object
  23. md.RegisterReq:
  24. properties:
  25. avatar:
  26. example: 头像
  27. type: string
  28. code:
  29. example: 验证码
  30. type: string
  31. invite_code:
  32. example: 邀请码
  33. type: string
  34. mobile:
  35. type: string
  36. nickname:
  37. example: 昵称
  38. type: string
  39. open_id:
  40. example: 微信openId
  41. type: string
  42. sex:
  43. description: 性别(0:未知 1:男 2:女)
  44. type: integer
  45. type:
  46. example: app:APP注册、h5:H5注册
  47. type: string
  48. union_id:
  49. example: 微信UnionId
  50. type: string
  51. required:
  52. - mobile
  53. type: object
  54. md.Response:
  55. properties:
  56. code:
  57. example: 响应码
  58. type: string
  59. data:
  60. description: 内容
  61. msg:
  62. example: 具体错误原因
  63. type: string
  64. type: object
  65. host: ddxq.izhim.com
  66. info:
  67. contact:
  68. email: 1239118001@qq.com
  69. name: dengbiao
  70. url: http://www.swagger.io/support
  71. description: APP客户端-Api接口
  72. license:
  73. name: Apache 2.0
  74. url: http://www.apache.org/licenses/LICENSE-2.0.html
  75. termsOfService: http://swagger.io/terms/
  76. title: 蛋蛋星球-APP客户端
  77. version: "1.0"
  78. paths:
  79. /api/v1/comm/getOssUrl:
  80. get:
  81. consumes:
  82. - application/json
  83. description: 上传许可链接(获取)
  84. parameters:
  85. - description: 验证参数Bearer和token空格拼接
  86. in: header
  87. name: Authorization
  88. required: true
  89. type: string
  90. produces:
  91. - application/json
  92. responses:
  93. "200":
  94. description: 许可链接
  95. schema:
  96. type: string
  97. "400":
  98. description: 具体错误
  99. schema:
  100. $ref: '#/definitions/md.Response'
  101. summary: 通用请求-对象存储-上传许可链接(获取)
  102. tags:
  103. - 对象存储
  104. /api/v1/test:
  105. get:
  106. consumes:
  107. - application/json
  108. description: Demo样例测试
  109. parameters:
  110. - description: 任意参数
  111. in: body
  112. name: req
  113. required: true
  114. schema: {}
  115. produces:
  116. - application/json
  117. responses:
  118. "200":
  119. description: 返回任意参数
  120. schema:
  121. additionalProperties: true
  122. type: object
  123. "400":
  124. description: 具体错误
  125. schema:
  126. $ref: '#/definitions/md.Response'
  127. summary: Demo测试
  128. tags:
  129. - Demo
  130. /v1/login:
  131. post:
  132. consumes:
  133. - application/json
  134. description: 登入
  135. parameters:
  136. - description: 用户名密码
  137. in: body
  138. name: req
  139. required: true
  140. schema:
  141. $ref: '#/definitions/md.LoginReq'
  142. produces:
  143. - application/json
  144. responses:
  145. "200":
  146. description: token
  147. schema:
  148. $ref: '#/definitions/md.LoginResponse'
  149. "400":
  150. description: 具体错误
  151. schema:
  152. $ref: '#/definitions/md.Response'
  153. summary: 登陆
  154. tags:
  155. - 登录
  156. /v1/register:
  157. post:
  158. consumes:
  159. - application/json
  160. description: 注册
  161. parameters:
  162. - description: 注册参数
  163. in: body
  164. name: req
  165. required: true
  166. schema:
  167. $ref: '#/definitions/md.RegisterReq'
  168. produces:
  169. - application/json
  170. responses:
  171. "200":
  172. description: 登录成功返回
  173. schema:
  174. $ref: '#/definitions/md.LoginResponse'
  175. "400":
  176. description: 具体错误
  177. schema:
  178. $ref: '#/definitions/md.Response'
  179. summary: 注册
  180. tags:
  181. - 注册
  182. swagger: "2.0"