bitforum-forum-api.postman_collection.json 10 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333
  1. {
  2. "info": {
  3. "name": "bitForum - Forum API",
  4. "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  5. },
  6. "auth": {
  7. "type": "bearer",
  8. "bearer": [
  9. {
  10. "key": "token",
  11. "value": "{{accessToken}}",
  12. "type": "string"
  13. }
  14. ]
  15. },
  16. "variable": [
  17. {
  18. "key": "baseUrl",
  19. "value": "https://localhost:4000"
  20. },
  21. {
  22. "key": "accessToken",
  23. "value": ""
  24. }
  25. ],
  26. "item": [
  27. {
  28. "name": "Board",
  29. "item": [
  30. {
  31. "name": "Search Boards",
  32. "request": {
  33. "method": "GET",
  34. "header": [],
  35. "url": {
  36. "raw": "{{baseUrl}}/api/forum/boards?pageNum=1&perPage=20",
  37. "host": ["{{baseUrl}}"],
  38. "path": ["api", "forum", "boards"],
  39. "query": [
  40. { "key": "boardGroupID", "value": "", "disabled": true },
  41. { "key": "keyword", "value": "", "disabled": true },
  42. { "key": "pageNum", "value": "1" },
  43. { "key": "perPage", "value": "20" }
  44. ]
  45. },
  46. "auth": { "type": "noauth" }
  47. }
  48. },
  49. {
  50. "name": "Get Board",
  51. "request": {
  52. "method": "GET",
  53. "header": [],
  54. "url": {
  55. "raw": "{{baseUrl}}/api/forum/boards/1",
  56. "host": ["{{baseUrl}}"],
  57. "path": ["api", "forum", "boards", "1"]
  58. },
  59. "auth": { "type": "noauth" }
  60. }
  61. },
  62. {
  63. "name": "Get Board Meta",
  64. "request": {
  65. "method": "GET",
  66. "header": [],
  67. "url": {
  68. "raw": "{{baseUrl}}/api/forum/boards/1/meta",
  69. "host": ["{{baseUrl}}"],
  70. "path": ["api", "forum", "boards", "1", "meta"]
  71. },
  72. "auth": { "type": "noauth" }
  73. }
  74. }
  75. ]
  76. },
  77. {
  78. "name": "Post",
  79. "item": [
  80. {
  81. "name": "Search Posts",
  82. "request": {
  83. "method": "GET",
  84. "header": [],
  85. "url": {
  86. "raw": "{{baseUrl}}/api/forum/posts?pageNum=1&perPage=20",
  87. "host": ["{{baseUrl}}"],
  88. "path": ["api", "forum", "posts"],
  89. "query": [
  90. { "key": "boardID", "value": "", "disabled": true },
  91. { "key": "search", "value": "", "disabled": true },
  92. { "key": "keyword", "value": "", "disabled": true },
  93. { "key": "startAt", "value": "", "disabled": true },
  94. { "key": "endAt", "value": "", "disabled": true },
  95. { "key": "sort", "value": "", "disabled": true },
  96. { "key": "isNotice", "value": "", "disabled": true },
  97. { "key": "isSecret", "value": "", "disabled": true },
  98. { "key": "isReply", "value": "", "disabled": true },
  99. { "key": "isDeleted", "value": "", "disabled": true },
  100. { "key": "pageNum", "value": "1" },
  101. { "key": "perPage", "value": "20" }
  102. ]
  103. },
  104. "auth": { "type": "noauth" }
  105. }
  106. },
  107. {
  108. "name": "Get Post",
  109. "request": {
  110. "method": "GET",
  111. "header": [],
  112. "url": {
  113. "raw": "{{baseUrl}}/api/forum/posts/1",
  114. "host": ["{{baseUrl}}"],
  115. "path": ["api", "forum", "posts", "1"]
  116. },
  117. "auth": { "type": "noauth" }
  118. }
  119. },
  120. {
  121. "name": "Create Post",
  122. "request": {
  123. "method": "POST",
  124. "header": [
  125. { "key": "Content-Type", "value": "application/json" }
  126. ],
  127. "body": {
  128. "mode": "raw",
  129. "raw": "{\n \"boardID\": 1,\n \"boardPrefixID\": null,\n \"subject\": \"테스트 제목\",\n \"content\": \"테스트 내용\",\n \"isSecret\": false\n}"
  130. },
  131. "url": {
  132. "raw": "{{baseUrl}}/api/forum/posts",
  133. "host": ["{{baseUrl}}"],
  134. "path": ["api", "forum", "posts"]
  135. }
  136. }
  137. },
  138. {
  139. "name": "Update Post",
  140. "request": {
  141. "method": "PUT",
  142. "header": [
  143. { "key": "Content-Type", "value": "application/json" }
  144. ],
  145. "body": {
  146. "mode": "raw",
  147. "raw": "{\n \"boardPrefixID\": null,\n \"subject\": \"수정된 제목\",\n \"content\": \"수정된 내용\",\n \"isSecret\": false\n}"
  148. },
  149. "url": {
  150. "raw": "{{baseUrl}}/api/forum/posts/1",
  151. "host": ["{{baseUrl}}"],
  152. "path": ["api", "forum", "posts", "1"]
  153. }
  154. }
  155. },
  156. {
  157. "name": "Delete Post",
  158. "request": {
  159. "method": "DELETE",
  160. "header": [],
  161. "url": {
  162. "raw": "{{baseUrl}}/api/forum/posts/1",
  163. "host": ["{{baseUrl}}"],
  164. "path": ["api", "forum", "posts", "1"]
  165. }
  166. }
  167. },
  168. {
  169. "name": "Toggle Post Reaction",
  170. "request": {
  171. "method": "POST",
  172. "header": [
  173. { "key": "Content-Type", "value": "application/json" }
  174. ],
  175. "body": {
  176. "mode": "raw",
  177. "raw": "{\n \"reaction\": 0\n}"
  178. },
  179. "url": {
  180. "raw": "{{baseUrl}}/api/forum/posts/1/reaction",
  181. "host": ["{{baseUrl}}"],
  182. "path": ["api", "forum", "posts", "1", "reaction"]
  183. }
  184. }
  185. },
  186. {
  187. "name": "Report Post",
  188. "request": {
  189. "method": "POST",
  190. "header": [
  191. { "key": "Content-Type", "value": "application/json" }
  192. ],
  193. "body": {
  194. "mode": "raw",
  195. "raw": "{\n \"type\": 0,\n \"reason\": \"신고 사유\"\n}"
  196. },
  197. "url": {
  198. "raw": "{{baseUrl}}/api/forum/posts/1/report",
  199. "host": ["{{baseUrl}}"],
  200. "path": ["api", "forum", "posts", "1", "report"]
  201. }
  202. }
  203. }
  204. ]
  205. },
  206. {
  207. "name": "Comment",
  208. "item": [
  209. {
  210. "name": "Search Comments",
  211. "request": {
  212. "method": "GET",
  213. "header": [],
  214. "url": {
  215. "raw": "{{baseUrl}}/api/forum/comments?pageNum=1&perPage=20",
  216. "host": ["{{baseUrl}}"],
  217. "path": ["api", "forum", "comments"],
  218. "query": [
  219. { "key": "boardID", "value": "", "disabled": true },
  220. { "key": "postID", "value": "", "disabled": true },
  221. { "key": "search", "value": "", "disabled": true },
  222. { "key": "keyword", "value": "", "disabled": true },
  223. { "key": "startAt", "value": "", "disabled": true },
  224. { "key": "endAt", "value": "", "disabled": true },
  225. { "key": "isDeleted", "value": "", "disabled": true },
  226. { "key": "pageNum", "value": "1" },
  227. { "key": "perPage", "value": "20" }
  228. ]
  229. },
  230. "auth": { "type": "noauth" }
  231. }
  232. },
  233. {
  234. "name": "Get Comment",
  235. "request": {
  236. "method": "GET",
  237. "header": [],
  238. "url": {
  239. "raw": "{{baseUrl}}/api/forum/comments/1",
  240. "host": ["{{baseUrl}}"],
  241. "path": ["api", "forum", "comments", "1"]
  242. },
  243. "auth": { "type": "noauth" }
  244. }
  245. },
  246. {
  247. "name": "Create Comment",
  248. "request": {
  249. "method": "POST",
  250. "header": [
  251. { "key": "Content-Type", "value": "application/json" }
  252. ],
  253. "body": {
  254. "mode": "raw",
  255. "raw": "{\n \"boardID\": 1,\n \"postID\": 1,\n \"parentID\": null,\n \"content\": \"테스트 댓글\",\n \"isSecret\": false\n}"
  256. },
  257. "url": {
  258. "raw": "{{baseUrl}}/api/forum/comments",
  259. "host": ["{{baseUrl}}"],
  260. "path": ["api", "forum", "comments"]
  261. }
  262. }
  263. },
  264. {
  265. "name": "Update Comment",
  266. "request": {
  267. "method": "PUT",
  268. "header": [
  269. { "key": "Content-Type", "value": "application/json" }
  270. ],
  271. "body": {
  272. "mode": "raw",
  273. "raw": "{\n \"content\": \"수정된 댓글\",\n \"isSecret\": false\n}"
  274. },
  275. "url": {
  276. "raw": "{{baseUrl}}/api/forum/comments/1",
  277. "host": ["{{baseUrl}}"],
  278. "path": ["api", "forum", "comments", "1"]
  279. }
  280. }
  281. },
  282. {
  283. "name": "Delete Comment",
  284. "request": {
  285. "method": "DELETE",
  286. "header": [],
  287. "url": {
  288. "raw": "{{baseUrl}}/api/forum/comments/1",
  289. "host": ["{{baseUrl}}"],
  290. "path": ["api", "forum", "comments", "1"]
  291. }
  292. }
  293. },
  294. {
  295. "name": "Toggle Comment Reaction",
  296. "request": {
  297. "method": "POST",
  298. "header": [
  299. { "key": "Content-Type", "value": "application/json" }
  300. ],
  301. "body": {
  302. "mode": "raw",
  303. "raw": "{\n \"reaction\": 0\n}"
  304. },
  305. "url": {
  306. "raw": "{{baseUrl}}/api/forum/comments/1/reaction",
  307. "host": ["{{baseUrl}}"],
  308. "path": ["api", "forum", "comments", "1", "reaction"]
  309. }
  310. }
  311. },
  312. {
  313. "name": "Report Comment",
  314. "request": {
  315. "method": "POST",
  316. "header": [
  317. { "key": "Content-Type", "value": "application/json" }
  318. ],
  319. "body": {
  320. "mode": "raw",
  321. "raw": "{\n \"type\": 0,\n \"reason\": \"신고 사유\"\n}"
  322. },
  323. "url": {
  324. "raw": "{{baseUrl}}/api/forum/comments/1/report",
  325. "host": ["{{baseUrl}}"],
  326. "path": ["api", "forum", "comments", "1", "report"]
  327. }
  328. }
  329. }
  330. ]
  331. }
  332. ]
  333. }