Home - SangleProject/Sangle GitHub Wiki

๐ŸŒŸ๐ŸŒŸ ์ถ”๊ฐ€๋ถ€๋ถ„ ๐ŸŒŸ๐ŸŒŸ

  1. ์œ ์ € ์ฐจ๋‹จ
  2. ์œ ์ € ์ฐจ๋‹จ ํ•ด์ œ
  3. ์œ ์ € ์ฐจ๋‹จ ๋ชฉ๋ก

๐ŸŒŸ๐ŸŒŸ ์ˆ˜์ •๋ถ€๋ถ„ ๐ŸŒŸ๐ŸŒŸ

  1. ๋‹ค๋ฅธ ์œ ์ € ํ”„๋กœํ•„
  2. ๋ช…์˜ˆ์˜ ์ „๋‹น
  • user์ •๋ณด์—์„œ ํ•œ์ค„์†Œ๊ฐœ(info)๊ฐ€ ""์ด๋ฉด ์•„์ง ์œ ์ €๊ฐ€ ํ•œ์ค„์†Œ๊ฐœ๋ฅผ ์ž‘์„ฑํ•˜์ง€ ์•Š์€ ๊ฒƒ
  • ์ผ๋ฐ˜ํšŒ์›๊ฐ€์ž… == ์†Œ์…œ๋กœ๊ทธ์ธ + ์ถ”๊ฐ€ ์ •๋ณด ์ž…๋ ฅ
  • ๋ฆฌํ”„๋ ˆ์‹œ ํ† ํฐ ์ฒ˜๋ฆฌ

๐Ÿ“ฑ๋กœ๊ทธ์ธ๐Ÿ“ฑ

Method Route Info
POST /users/login/login-by-apple ์• ํ”Œ ๋กœ๊ทธ์ธ ๊ฒ€์ฆ
POST /login/refresh ์• ํ”Œ ๋ฆฌํ”„๋ ˆ์‹œ
POST /users/google ๊ตฌ๊ธ€ ๋กœ๊ทธ์ธ ๊ฒ€์ฆ
PUT /users/social ์ถ”๊ฐ€ ์ •๋ณด ์ž…๋ ฅ
PUT /users/updateToken device_token ์—…๋ฐ์ดํŠธ
POST /users/signup ์ผ๋ฐ˜ ํšŒ์›๊ฐ€์ž…
POST /users/signin ์ผ๋ฐ˜ ๋กœ๊ทธ์ธ
POST /users/checkEmail ์ด๋ฉ”์ผ ์ค‘๋ณต์ฒดํฌ
POST /users/checkNickName ๋‹‰๋„ค์ž„ ์ค‘๋ณต์ฒดํฌ
GET /users/refresh ํ† ํฐ ๋งŒ๋ฃŒ

๐Ÿ˜›์œ ์ €๐Ÿ˜›

Method Route Info
GET /users/profile ํ”„๋กœํ•„ ์ˆ˜์ •ํ•˜๊ธฐ ์ „ ์ •๋ณด, My์„œ๋ž์—์„œ ๋‚ด ์ •๋ณด
PUT /users/update ํ”„๋กœํ•„ ์ˆ˜์ •
DELETE /users/delete ํšŒ์›ํƒˆํ‡ด
GET /badgeList ๋ฐฐ์ง€ ๋ฆฌ์ŠคํŠธ๋ทฐ
POST /users/addBlocking/{blockUserIdx} ์œ ์ € ์ฐจ๋‹จ
DELETE /users/deleteBlocking/{blockUserIdx} ์œ ์ € ์ฐจ๋‹จ ํ•ด์ œ
GET /users/blockList ์œ ์ € ์ฐจ๋‹จ ๋ชฉ๋ก

๐Ÿ“๋ฉ”์ธ๐Ÿ“

Method Route Info
GET /main/searchUser?user=#{user} ์œ ์ € ๊ฒ€์ƒ‰
GET /main/searchPost?post=#{post} ๊ธ€ ๋‚ด์šฉ ๊ฒ€์ƒ‰
GET /main/searchTopic?topic=#{topic} ๊ธ€๊ฐ ๊ฒ€์ƒ‰
GET /main/info ๋ฉ”์ธ ์œ ์ € ์ •๋ณด
GET /cal/day ๋‹ฌ๋ณ„ ๋งค์ผ ๊ธ€์ž‘์„ฑ ํ˜„ํ™ฉ
GET /cal/week ์ฃผ๋ณ„ ๋‹ฌ์„ฑ๋ฅ 
GET /main/diffProfile/{nickName} ๋‹ค๋ฅธ ์œ ์ € ํ”„๋กœํ•„
GET /main/diffFeed/{nickName}(?filter="popular") ๋‹ค๋ฅธ ์œ ์ € ํ”ผ๋“œ (์ตœ์‹ ์ˆœ or ์ธ๊ธฐ์ˆœ)
GET /main/allNotice ๊ณต์ง€์‚ฌํ•ญ ๋ฆฌ์ŠคํŠธ
GET /main/notice ์•Œ๋ฆผ๋ทฐ

โœŒ๏ธMy ์„œ๋žโœŒ๏ธ

Method Route Info
GET /main/searchMyTopic?topic=#{topic} My ์„œ๋ž ๋‚ด ๊ธ€๊ฐ ๊ฒ€์ƒ‰
GET /main/searchScrapTopic?topic=#{topic} My ์„œ๋ž ๋‹ด์€ ๊ธ€๊ฐ ๊ฒ€์ƒ‰
GET /posts/myPost(?filter="popular") ๋‚ด๊ฐ€ ์ž‘์„ฑํ•œ ๊ธ€ ๋ชฉ๋ก(์ตœ์‹ ์ˆœ or ์ธ๊ธฐ์ˆœ)
GET /posts/likes(?filter="popular") ๋‚ด๊ฐ€ ์ข‹์•„์š” ํ•œ ๊ธ€ ๋ชฉ๋ก(์ตœ์‹ ์ˆœ or ์ธ๊ธฐ์ˆœ)
GET /posts/scrap(?filter="popular") ๋‚ด๊ฐ€ ๋‹ด์€ ๊ธ€ ๋ชฉ๋ก(์ตœ์‹ ์ˆœ or ์ธ๊ธฐ์ˆœ)

๐ŸŒŒ๊ฒŒ์‹œ๊ธ€๐ŸŒŒ

Method Route Info
GET /posts/popularity ๋ช…์˜ˆ์˜ ์ „๋‹น
GET /posts/all?topic="#{topic}"(&filter="popular") ๊ธ€๊ฐ๋ณ„ ์ „์ฒด๊ณต๊ฐœ๋œ ๋ชจ๋“  ๊ธ€ ๋ชฉ๋ก(์ตœ์‹ ์ˆœ or ์ธ๊ธฐ์ˆœ)
POST /posts/write ๊ธ€ ์ž‘์„ฑ
PUT /posts/update/{postIdx} ๊ธ€ ์ˆ˜์ •
PUT /posts/open/{postIdx} ๊ธ€ ๊ณต๊ฐœ์—ฌ๋ถ€
DELETE /posts/delete/{postIdx} ๊ธ€ ์‚ญ์ œ
POST /posts/likes/{postIdx} ์ข‹์•„์š”
DELETE /posts/unlikes/{postIdx} ์ข‹์•„์š” ์ทจ์†Œ
POST /posts/scrap/{postIdx} ์Šคํฌ๋žฉ
DELETE /posts/unscrap/{postIdx} ์Šคํฌ๋žฉ ์ทจ์†Œ
GET /posts/detail/{postIdx} ๋‚ด๊ฐ€ ์“ด ๊ฒŒ์‹œ๊ธ€ ์ž์„ธํžˆ ๋ณด๊ธฐ
GET /posts/detailDiff/{postIdx} ๋‹ค๋ฅธ ์œ ์ €๊ฐ€ ์“ด ๊ฒŒ์‹œ๊ธ€ ์ž์„ธํžˆ ๋ณด๊ธฐ

โšก๊ธ€๊ฐโšก

Method Route Info
GET /topic/today ์˜ค๋Š˜์˜ ๋žœ๋ค ๊ธ€๊ฐ ๊ฐ€์ ธ์˜ค๊ธฐ
GET /topic/lastTopic(?used=true)(?used=false) ์ง€๋‚œ ๊ธ€๊ฐ๋“ค(์ตœ๊ทผ 10์ผ)
GET /topic/lastAllTopic ์ง€๋‚œ ๊ธ€๊ฐ๋“ค ์ „์ฒด๋ณด๊ธฐ
POST /topic/written ๋‚ด๊ฐ€ ์“ด ๊ธ€๊ฐ์ธ์ง€ ํ™•์ธ(๋ธ”๋ผ์ธ๋“œ ์ฒ˜๋ฆฌ์šฉ)