Advertisement
Guest User

Untitled

a guest
Dec 1st, 2017
79
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 5.83 KB | None | 0 0
  1. # 0. Errors
  2. * If your request is bad, you will get next
  3. ### response:
  4.  
  5. ``````
  6. {
  7. success:false,
  8. message:String
  9. }
  10. ``````
  11. # 1. Auth
  12. * # **Login**
  13. `post(/api/v1/auth/login)`
  14.  
  15. ### request:
  16. ``````
  17. {
  18. email:String,
  19. password:String
  20. }
  21. ``````
  22. ### response:
  23. ``````
  24. {
  25. success:true,
  26. tokens:
  27. [
  28. access:String,
  29. refresh:String
  30. ],
  31. user:
  32. {
  33. fullname:String,
  34. email:String,
  35. telegram:String,
  36. id:String
  37. }
  38. }
  39. ``````
  40. * # **Register**
  41. `post(/api/v1/auth/register)`
  42.  
  43. ### request:
  44. ``````
  45. {
  46. email:String,
  47. password:String,
  48. fullname:String,
  49. telegram{optional}:String
  50. }
  51. ``````
  52. ### response:
  53. ``````
  54. {
  55. success:true,
  56. tokens:
  57. [
  58. access:String,
  59. refresh:String
  60. ],
  61. user:
  62. {
  63. fullname:String,
  64. email:String,
  65. telegram:String,
  66. id:String
  67. }
  68. }
  69. ``````
  70. * # **Logout**
  71. `post(/api/v1/auth/logout)`
  72.  
  73. ### request:
  74. ``````
  75. {
  76. {SEND BEARER AUTHORIZATION HEADER}
  77. }
  78. ``````
  79. ### response:
  80. ``````
  81. {
  82. success:true,
  83. }
  84. ``````
  85. * # **Get new access token**
  86. `post(/api/v1/auth/token)`
  87.  
  88. ### request:
  89. ``````
  90. {
  91. {SEND BEARER AUTHORIZATION HEADER}
  92. }
  93. ``````
  94. ### response:
  95. ``````
  96. {
  97. success:true,
  98. tokens:String
  99. }
  100. ``````
  101. ## 2. Publications
  102. * # **Search**
  103. `get(/api/v1/publications)`
  104.  
  105. request (use URL-encoded request):
  106. ``````
  107. page:Number(>0) (optinal)
  108. limit:Number(>0) (optinal)
  109. title:String (optinal)
  110. author:String (optinal)
  111. tags:["String"] (optinal)
  112. id:String (optinal)
  113. ``````
  114. ### response:
  115. ``````
  116. {
  117. success:true,
  118. query:String [computed search query],
  119. page: Number,
  120. total: Number,
  121. limit: Number,
  122. pager: Number,
  123. items:
  124. [
  125. {
  126. title: String,
  127. author_id: String,
  128. image_id: String,
  129. text: String,
  130. description: String,
  131. id: String,
  132. createdAt: String,
  133. tags: [String],
  134. difficult: Number
  135. }
  136. ]
  137. }
  138. ``````
  139. * # **Delete**
  140. `delete(/api/v1/publications)`
  141.  
  142. ### request:
  143. ``````
  144. {
  145. id:String
  146. }
  147. ``````
  148. ### response:
  149. ``````
  150. {
  151. success:true,
  152. query:String [computed search query],
  153. publication:
  154. {
  155. title: String,
  156. author_id: String,
  157. image_id: String,
  158. text: String,
  159. description: String,
  160. id: String,
  161. createdAt: String,
  162. tags: [String],
  163. difficult: Number
  164. }
  165. }
  166. ``````
  167. * # **Update**
  168. `put(/api/v1/publications)`
  169.  
  170. ### request:
  171. ``````
  172. {
  173. target:String,
  174. title:String,
  175. description:String,
  176. text:String,
  177. difficult:Number,
  178. add_tags:[String] [list of new tags],
  179. remvoe_tags:[String] [list of tags to remove]
  180. image_id:String
  181. }
  182. ``````
  183. ### response:
  184. ``````
  185. eq. Publication.delete
  186. ``````
  187. * # **Create**
  188. `post(/api/v1/publications)`
  189.  
  190. ### request:
  191. ``````
  192. {
  193. title:String,
  194. description:String,
  195. text:String,
  196. difficult:Number,
  197. tags:[String],
  198. image_id:String
  199. }
  200. ``````
  201. ### response:
  202. ``````
  203. {
  204. success:true,
  205. publication:
  206. {
  207. title: String,
  208. author_id: String,
  209. image_id: String,
  210. text: String,
  211. description: String,
  212. id: String,
  213. createdAt: String,
  214. tags: [String],
  215. difficult: Number
  216. }
  217. }
  218. ``````
  219. ## 2. Users
  220. * # **Search**
  221. `get(/api/v1/users)`
  222.  
  223. request (use URL-encoded request):
  224. ``````
  225. page:Number(>0) (optinal)
  226. limit:Number(>0) (optinal)
  227. fullname:String (optinal)
  228. email:String (optinal)
  229. publications:["String"] (optinal)
  230. id:String (optinal)
  231. isAdmin:Boolean (optinal)
  232. telegram:String (optinal)
  233. ``````
  234. ### response:
  235. ``````
  236. {
  237. success:true,
  238. query:String [computed search query],
  239. page: Number,
  240. total: Number,
  241. limit: Number,
  242. pager: Number,
  243. items:
  244. [
  245. {
  246. fullname: String,
  247. telegram: String,
  248. email: String,
  249. isAdmun: Boolean,
  250. publicaitons: [String],
  251. id: String
  252. }
  253. ]
  254. }
  255. ``````
  256. * # **Delete**
  257. `delete(/api/v1/users)`
  258.  
  259. ### request:
  260. ``````
  261. {
  262. id:String
  263. }
  264. ``````
  265. ### response:
  266. ``````
  267. {
  268. success:true,
  269. query:String [computed search query],
  270. user:
  271. {
  272. fullname: String,
  273. telegram: String,
  274. email: String,
  275. isAdmun: Boolean,
  276. publicaitons: [String],
  277. id: String
  278. }
  279. }
  280. ``````
  281. * # **Update**
  282. `put(/api/v1/users)`
  283.  
  284. ### request:
  285. ``````
  286. {
  287. target:String,
  288. fullname:String (optinal)
  289. email:String (optinal
  290. password:String (optional)
  291. id:String (optinal)
  292. isAdmin:Boolean (optinal)
  293. telegram:String (optinal)
  294. }
  295. ``````
  296. ### response:
  297. ``````
  298. eq. Users.delete
  299. ``````
  300. ## 3. Resources
  301. * # **Get**
  302. `get(/api/v1/res)`
  303.  
  304. request (use URL-encoded request):
  305. ``````
  306. id:String
  307. ``````
  308. response:
  309. ``````
  310. file-data
  311. ``````
  312. * # **Delete**
  313. `delete(/api/v1/res)`
  314.  
  315. ### request:
  316. ``````
  317. {
  318. id:String
  319. }
  320. ``````
  321. ### response:
  322. ``````
  323. {
  324. success:true,
  325. id: String
  326. }
  327. ``````
  328. * # **Create**
  329. `post(/api/v1/res)`
  330.  
  331. ### request:
  332. ``````
  333. [use form-data header]
  334. {
  335. file:File
  336. }
  337. ``````
  338. ### response:
  339. ``````
  340. {
  341. success:true,
  342. id:String
  343. }
  344. ``````
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement