Skip to content

User API

JeongHyeon Kim edited this page Dec 6, 2025 · 3 revisions

๐Ÿ“˜ User API (Minimal Spec - v1)

์‚ฌ์šฉ์ž ๊ด€๋ จ ๊ธฐ๋Šฅ์„ ์ œ๊ณตํ•˜๋Š” API ๋ชจ์Œ์ž…๋‹ˆ๋‹ค.
ํšŒ์› ์กฐํšŒ, ํšŒ์› ์ •๋ณด ์ˆ˜์ •, ํ”„๋กœํ•„ ์ด๋ฏธ์ง€ ๋ณ€๊ฒฝ ๋“ฑ ์‚ฌ์šฉ์ž ๋„๋ฉ”์ธ ์ „๋ฐ˜์„ ๋‹ค๋ฃน๋‹ˆ๋‹ค.

1. ์‚ฌ์šฉ์ž ๋‹จ๊ฑด ์กฐํšŒ

GET /api/v1/users/{userId}

์‚ฌ์šฉ์ž ์ •๋ณด๋ฅผ ์กฐํšŒํ•ฉ๋‹ˆ๋‹ค.


๐Ÿ“ฅ Request

Path Variables

  • userId : ์‚ฌ์šฉ์ž ID

Headers

  • Authorization : Bearer Token

๐Ÿ“ค Response (200)

{
  "id": 1,
  "email": "test@example.com",
  "nickName": "ํ™๊ธธ๋™",
  "profileImage": "https://cdn.myapp.com/user/profile/123.png",
  "notification_enabled": "1",
  "mbti": "ISTP",
  "phoneNumber": "010-1234_5678",
  "profileMessage": "์•ˆ๋…•ํ•˜์„ธ์š”~"
}

2. ํ”„๋กœํ•„ ํŽธ์ง‘

PATCH /api/v1/users

์‚ฌ์šฉ์ž ์ •๋ณด๋ฅผ ์ผ๋ถ€ ์ˆ˜์ •ํ•ฉ๋‹ˆ๋‹ค.


๐Ÿ“ฅ Request

โ€ป ๋ณธ์ธ ํ”„๋กœํ•„๋งŒ ์ˆ˜์ • ๊ฐ€๋Šฅํ•˜๊ธฐ์— PathVariable ์ œ๊ฑฐํ–ˆ์Šต๋‹ˆ๋‹ค.

Headers

  • Authorization : Bearer Token

Body

ํด๋ผ์ด์–ธํŠธ์—์„œ๋Š” ๋ณ€๊ฒฝ๋œ ๋ถ€๋ถ„๋งŒ ์ „์†ก

{
  "nickName": "์ •ํ˜„",
  "notification_enabled": "0",
  "mbti": "ISFJ",
  "phoneNumber": "010-1234_5678",
  "profileMessage": "๋ณ€๊ฒฝ๋œ ์ƒํƒœ๋ฉ”์‹œ์ง€"

๐Ÿ“ค Response (200)

ํ•ด๋‹น ์‚ฌ์šฉ์ž์˜ ๋ณ€๊ฒฝ๋œ ์ „์ฒด ๋ฐ์ดํ„ฐ๋ฅผ ์‘๋‹ต

{
  "id": 1,
  "email": "test@example.com",
  "nickName": "์ •ํ˜„",
  "profileImage": "https://cdn.myapp.com/user/profile/123.png",
  "notification_enabled": "0",
  "mbti": "ISFJ",
  "phoneNumber": "010-1234_5678",
  "profileMessage": "๋ณ€๊ฒฝ๋œ ์ƒํƒœ๋ฉ”์‹œ์ง€"
}

3. ํšŒ์›ํƒˆํ‡ด

DELETE /api/v1/users

์‚ฌ์šฉ์ž ํšŒ์›ํƒˆํ‡ด


๐Ÿ“ฅ Request

Headers

  • Authorization : Bearer Token

๐Ÿ“ค Response (204 No Content)


3. ์‚ฌ์šฉ์ž ํ”„๋กœํ•„ ์ด๋ฏธ์ง€ ๋ณ€๊ฒฝ

S3Presigned URL ๋ฐฉ์‹ or Multi-Part ๋ฐฉ์‹ ๋…ผ์˜ ์ดํ›„ ์ž‘์„ฑ

Storage Service : S3 ์‚ฌ์šฉ ํ™•์ •


4. ์‚ฌ์šฉ์ž ํŒ”๋กœ์šฐ

POST /api/v1/follows/{followId}

์‚ฌ์šฉ์ž ํŒ”๋กœ์šฐ๋ฅผ ๋“ฑ๋กํ•ฉ๋‹ˆ๋‹ค.


๐Ÿ“ฅ Request

Headers

  • Authorization : Bearer Token

๐Ÿ“ค Response (204 No Content)


5. ์‚ฌ์šฉ์ž ์–ธํŒ”๋กœ์šฐ

DELETE /api/v1/follows/{followId}

๋Œ€์ƒ ์‚ฌ์šฉ์ž๋ฅผ ์–ธํŒ”๋กœ์šฐํ•ฉ๋‹ˆ๋‹ค.


๐Ÿ“ฅ Request

Path Variables

  • followId : ์–ธํŒ”๋กœ์šฐ ๋Œ€์ƒ ์‚ฌ์šฉ์ž ID

Headers

  • Authorization : Bearer Token

๐Ÿ“ค Response (204 No Content)

๐Ÿ“š ์ฐธ๊ณ  ๋ฌธ์„œ

Clone this wiki locally