swagger.json 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202
  1. {
  2. "swagger": "2.0",
  3. "info": {
  4. "contact": {},
  5. "license": {}
  6. },
  7. "paths": {
  8. "/check": {
  9. "post": {
  10. "consumes": [
  11. "multipart/form-data"
  12. ],
  13. "produces": [
  14. "application/json"
  15. ],
  16. "summary": "登陆验证接口",
  17. "parameters": [
  18. {
  19. "type": "string",
  20. "description": "用户名",
  21. "name": "username",
  22. "in": "formData",
  23. "required": true
  24. },
  25. {
  26. "type": "string",
  27. "description": "密码",
  28. "name": "password",
  29. "in": "formData",
  30. "required": true
  31. },
  32. {
  33. "type": "string",
  34. "description": "类型",
  35. "name": "type",
  36. "in": "formData",
  37. "required": true
  38. }
  39. ],
  40. "responses": {
  41. "200": {
  42. "description": "OK",
  43. "schema": {
  44. "$ref": "#/definitions/controller.Response"
  45. }
  46. }
  47. }
  48. }
  49. },
  50. "/message": {
  51. "post": {
  52. "consumes": [
  53. "multipart/form-data"
  54. ],
  55. "produces": [
  56. "application/json"
  57. ],
  58. "summary": "发送消息接口",
  59. "parameters": [
  60. {
  61. "type": "string",
  62. "description": "来源uid",
  63. "name": "from_id",
  64. "in": "formData",
  65. "required": true
  66. },
  67. {
  68. "type": "string",
  69. "description": "目标uid",
  70. "name": "to_id",
  71. "in": "formData",
  72. "required": true
  73. },
  74. {
  75. "type": "string",
  76. "description": "内容",
  77. "name": "content",
  78. "in": "formData",
  79. "required": true
  80. },
  81. {
  82. "type": "string",
  83. "description": "类型|kefu,visitor",
  84. "name": "type",
  85. "in": "formData",
  86. "required": true
  87. }
  88. ],
  89. "responses": {
  90. "200": {
  91. "description": "OK",
  92. "schema": {
  93. "$ref": "#/definitions/controller.Response"
  94. }
  95. }
  96. }
  97. }
  98. },
  99. "/messages": {
  100. "get": {
  101. "consumes": [
  102. "multipart/form-data"
  103. ],
  104. "produces": [
  105. "application/json"
  106. ],
  107. "summary": "获取访客聊天信息接口",
  108. "parameters": [
  109. {
  110. "type": "string",
  111. "description": "访客ID",
  112. "name": "visitorId",
  113. "in": "query",
  114. "required": true
  115. },
  116. {
  117. "type": "string",
  118. "description": "认证token",
  119. "name": "token",
  120. "in": "header",
  121. "required": true
  122. }
  123. ],
  124. "responses": {
  125. "200": {
  126. "description": "OK",
  127. "schema": {
  128. "$ref": "#/definitions/controller.Response"
  129. }
  130. }
  131. }
  132. }
  133. },
  134. "/visitors": {
  135. "get": {
  136. "consumes": [
  137. "multipart/form-data"
  138. ],
  139. "produces": [
  140. "application/json"
  141. ],
  142. "summary": "获取访客列表接口",
  143. "parameters": [
  144. {
  145. "type": "string",
  146. "description": "分页",
  147. "name": "page",
  148. "in": "query",
  149. "required": true
  150. },
  151. {
  152. "type": "string",
  153. "description": "认证token",
  154. "name": "token",
  155. "in": "header",
  156. "required": true
  157. }
  158. ],
  159. "responses": {
  160. "200": {
  161. "description": "OK",
  162. "schema": {
  163. "$ref": "#/definitions/controller.Response"
  164. }
  165. }
  166. }
  167. }
  168. },
  169. "/visitors_online": {
  170. "get": {
  171. "produces": [
  172. "application/json"
  173. ],
  174. "summary": "获取在线访客列表接口",
  175. "responses": {
  176. "200": {
  177. "description": "OK",
  178. "schema": {
  179. "$ref": "#/definitions/controller.Response"
  180. }
  181. }
  182. }
  183. }
  184. }
  185. },
  186. "definitions": {
  187. "controller.Response": {
  188. "type": "object",
  189. "properties": {
  190. "code": {
  191. "type": "integer"
  192. },
  193. "msg": {
  194. "type": "string"
  195. },
  196. "result": {
  197. "type": "object"
  198. }
  199. }
  200. }
  201. }
  202. }