What does your API do?
\nThings that the developers should know about
\nWhat is the preferred way of using the API?
\nWhat errors and status codes can a user expect?
\nIs there a limit to the number of requests a user can send?
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Overview","slug":"overview"},{"content":"Authentication","slug":"authentication"},{"content":"Error Codes","slug":"error-codes"},{"content":"Rate limit","slug":"rate-limit"}],"owner":"20763232","collectionId":"7d2955a1-1294-40c5-af62-ae34a3f6349c","publishedId":"2s8Z6x4ZUB","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2022-12-28T13:52:33.000Z"},"item":[{"name":"회원가입","id":"768b0704-a3c1-4853-bd06-917ea86a636d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"matisflkd@naver.com\",\n \"nickname\": \"오이\",\n \"password\": \"qwerty1234\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/member/signup","description":"회원가입을 진행합니다.
\n(클라이언트는 result.id 를 memberId 로 간주해서 사용하면 됩니다.)
글을 작성합니다.
클라이언트에서는 결과로 반환된 post의 id를 postId로 사용하면 됩니다.
(존재하지 않는 사용자 글 작성시 예외처리 필요)
\n","urlObject":{"protocol":"http","port":"4041","path":["api","v1","post"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"8ee83342-e9ba-4ae9-ab4b-b9ae4e9581ed","name":"글 작성","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"title\": \"글 작성 테스트 🐰\",\n \"content\": \"저는 토끼띠예요\",\n \"memberId\": 1\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/post"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 11:05:43 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"post\": {\n \"createdDate\": \"2022-12-28T20:05:43.441692\",\n \"modifiedDate\": \"2022-12-28T20:05:43.441692\",\n \"id\": 4,\n \"title\": \"글 작성 테스트 🐰\",\n \"content\": \"저는 토끼띠예요\",\n \"hits\": 0,\n \"likeCount\": 0,\n \"commentCount\": 0,\n \"commentList\": [],\n \"heartList\": []\n }\n }\n}"}],"_postman_id":"db77134a-3157-4d12-a001-a644a21f93b0"},{"name":"글 삭제","id":"1660bb99-6dcf-44ef-acc3-d081b82bd9f3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/post/delete?id=4","description":"글을 삭제합니다.
\n글 작성시 받았던 post 객체의 id를 쿼리스트링으로 요청해주시면 됩니다.
\n(세션이나 로컬스토리지를 사용한 권한 처리는 생략했습니다.
\n나중에 시간 나면 수정해보기)
\n","urlObject":{"protocol":"http","port":"4041","path":["api","v1","post","delete"],"host":["localhost"],"query":[{"key":"id","value":"4"}],"variable":[]}},"response":[{"id":"98c15985-ef73-4216-9ed4-100cce1c55d8","name":"글 삭제","originalRequest":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"http://localhost:4041/api/v1/post/delete?id=2","protocol":"http","host":["localhost"],"port":"4041","path":["api","v1","post","delete"],"query":[{"key":"id","value":"2"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 11:04:55 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"result\": \"삭제 완료 - 삭제된 글 id : 2\"\n }\n}"}],"_postman_id":"1660bb99-6dcf-44ef-acc3-d081b82bd9f3"},{"name":"댓글 작성","id":"9d387b0b-2bbe-49cc-a2d5-d3c6daabc2cd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"content\": \"토끼띠라니 ~~~ \",\n \"postId\": \"5\",\n \"memberId\": \"2\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/comment","description":"댓글을 작성합니다.
\ncontent에는 댓글 내용을,
\npostId는 원본 글 작성시 받았던 id를,
\nmemberId는 회원가입시 받았던 작성자 id(int)를 넣어주시면 됩니다.
\n","urlObject":{"protocol":"http","port":"4041","path":["api","v1","comment"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ba85dd50-2f51-47fa-910a-87b2770cd521","name":"댓글 작성","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"content\": \"토끼띠라니 ~~~ \",\n \"postId\": \"4\",\n \"memberId\": \"2\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/comment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 11:07:48 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"comment\": {\n \"createdDate\": \"2022-12-28T20:07:48.350726\",\n \"modifiedDate\": \"2022-12-28T20:07:48.350726\",\n \"id\": 3,\n \"content\": \"토끼띠라니 ~~~ \"\n }\n }\n}"}],"_postman_id":"9d387b0b-2bbe-49cc-a2d5-d3c6daabc2cd"},{"name":"\b댓글 삭제","id":"17177a53-259c-4428-9841-09f95243cf58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":""},"url":"http://localhost:4041/api/v1/comment/delete?id=5","description":"댓글을 삭제합니다.
\n댓글 작성시 받았던 comment의 id를 쿼리스트링으로 전달해주시면 됩니다.
\n","urlObject":{"protocol":"http","port":"4041","path":["api","v1","comment","delete"],"host":["localhost"],"query":[{"key":"id","value":"5"}],"variable":[]}},"response":[{"id":"861af49a-7ff3-4ca2-92f6-8ee495a49a9c","name":"\b댓글 삭제","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"http://localhost:4041/api/v1/comment/delete?id=3","protocol":"http","host":["localhost"],"port":"4041","path":["api","v1","comment","delete"],"query":[{"key":"id","value":"3"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 11:08:00 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"result\": \"댓글 삭제 완료 - 삭제된 댓글 id : 3\"\n }\n}"}],"_postman_id":"17177a53-259c-4428-9841-09f95243cf58"},{"name":"좋아요","id":"d2caf6f4-6948-4cd0-b3b9-603f95cc79c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"memberId\": 1,\n \"postId\": 12\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/heart","description":"좋아요 버튼에 대한 요청을 처리합니다.
좋아요를 누른 사람의 id와 원본 게시글의 id를 받아 저장하고,
이미 좋아요 된 경우, 좋아요를 취소(unheart) 후 DB에서 삭제합니다.
엔드포인트로 GET 요청을 주시면 (/api/v1/readall/newest)
result 객체에 전체 게시글 정보를 리스트로 반환합니다.
\n","urlObject":{"protocol":"http","port":"4041","path":["api","v1","readall","newest"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"7d439ac8-1a15-41a9-8a53-60726cf5bc22","name":"전체 글 조회 (최신순)","originalRequest":{"method":"GET","header":[],"url":"http://localhost:4041/api/v1/readall/newest"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 11:45:51 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"result\": [\n {\n \"createdDate\": \"2022-12-28T20:10:56.068192\",\n \"modifiedDate\": \"2022-12-28T20:10:56.068192\",\n \"id\": 8,\n \"title\": \"글 작성 테스트 🐰\",\n \"content\": \"저는 토끼띠예요\",\n \"hits\": 0,\n \"likeCount\": 0,\n \"commentCount\": 0,\n \"commentList\": [],\n \"heartList\": []\n },\n {\n \"createdDate\": \"2022-12-28T20:10:55.183668\",\n \"modifiedDate\": \"2022-12-28T20:10:55.183668\",\n \"id\": 7,\n \"title\": \"글 작성 테스트 🐰\",\n \"content\": \"저는 토끼띠예요\",\n \"hits\": 0,\n \"likeCount\": 0,\n \"commentCount\": 0,\n \"commentList\": [],\n \"heartList\": []\n },\n {\n \"createdDate\": \"2022-12-28T20:10:54.457375\",\n \"modifiedDate\": \"2022-12-28T20:10:54.457375\",\n \"id\": 6,\n \"title\": \"글 작성 테스트 🐰\",\n \"content\": \"저는 토끼띠예요\",\n \"hits\": 0,\n \"likeCount\": 0,\n \"commentCount\": 0,\n \"commentList\": [],\n \"heartList\": []\n },\n {\n \"createdDate\": \"2022-12-28T20:10:53.734579\",\n \"modifiedDate\": \"2022-12-28T20:12:41.719007\",\n \"id\": 5,\n \"title\": \"글 작성 테스트 🐰\",\n \"content\": \"저는 토끼띠예요\",\n \"hits\": 0,\n \"likeCount\": 0,\n \"commentCount\": 1,\n \"commentList\": [\n {\n \"createdDate\": \"2022-12-28T20:12:02.253611\",\n \"modifiedDate\": \"2022-12-28T20:12:02.253611\",\n \"id\": 4,\n \"content\": \"토끼띠라니 ~~~ \"\n }\n ],\n \"heartList\": []\n },\n {\n \"createdDate\": \"2022-12-28T20:03:42.306755\",\n \"modifiedDate\": \"2022-12-28T20:03:42.306755\",\n \"id\": 1,\n \"title\": \"글 작성 테스트 😇\",\n \"content\": \"코코톤화이팅~\",\n \"hits\": 0,\n \"likeCount\": 0,\n \"commentCount\": 0,\n \"commentList\": [],\n \"heartList\": []\n }\n ]\n }\n}"}],"_postman_id":"a0009b1c-3b51-4723-97cb-25f0572e914e"},{"name":"저장된 전체 데이터 조회","id":"0f00b58a-7bd6-47fe-9dd7-aa5abd5e49b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/data","description":"저장된 모든 데이터를 조회합니다.
\n엔드포인트로 GET 요청을 주시면 (/api/v1/data)
result 객체에 리스트로 결과가 담겨집니다.
\n","urlObject":{"protocol":"http","port":"4041","path":["api","v1","data"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"b05c1ae1-fad6-4946-94b2-52cb510c084e","name":"저장된 전체 데이터 조회","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/data"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 12:41:32 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"result\": [\n {\n \"id\": 1,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 2,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 3,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 4,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 5,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 6,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 7,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 8,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 9,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n },\n {\n \"id\": 10,\n \"title\": \"테스트 제목 😇\",\n \"period\": \"07.15~01.31\",\n \"genre\": \"musical\",\n \"picture\": \"samplelink.com\"\n }\n ]\n }\n}"}],"_postman_id":"0f00b58a-7bd6-47fe-9dd7-aa5abd5e49b1"},{"name":"로그인 요청","id":"af4f22d2-3dff-41c7-bacb-a1a6a45e3c0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"okok@naver.com\",\n \"password\": \"qwerty1234\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/member/login","urlObject":{"protocol":"http","port":"4041","path":["api","v1","member","login"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"bcc4c9f9-ee32-47bf-97f9-1fe2362eed01","name":"로그인 요청 실패","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"rabbitdf@naver.com\",\n \"password\": \"rabbitdf@naver.com\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/member/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 15:50:16 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 500,\n \"message\": \"(500) 서버 오류\"\n },\n \"body\": null\n}"},{"id":"50e0da8e-3ad6-4b1c-b052-667af56ad227","name":"로그인 요청 성공","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"email\": \"okok@naver.com\",\n \"password\": \"qwerty1234\"\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:4041/api/v1/member/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Vary","value":"Origin"},{"key":"Vary","value":"Access-Control-Request-Method"},{"key":"Vary","value":"Access-Control-Request-Headers"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"Cache-Control","value":"no-cache, no-store, max-age=0, must-revalidate"},{"key":"Pragma","value":"no-cache"},{"key":"Expires","value":"0"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Date","value":"Wed, 28 Dec 2022 15:54:44 GMT"},{"key":"Keep-Alive","value":"timeout=60"},{"key":"Connection","value":"keep-alive"}],"cookie":[],"responseTime":null,"body":"{\n \"header\": {\n \"code\": 200,\n \"message\": \"(200) SUCCESS\"\n },\n \"body\": {\n \"member\": {\n \"createdDate\": \"2022-12-28T20:02:50.93773\",\n \"modifiedDate\": \"2022-12-28T20:02:50.93773\",\n \"id\": 4,\n \"email\": \"okok@naver.com\",\n \"password\": \"qwerty1234\",\n \"role\": \"MEMBER\",\n \"nickname\": \"감🥔\"\n }\n }\n}"}],"_postman_id":"af4f22d2-3dff-41c7-bacb-a1a6a45e3c0d"}]}