Skip to content

User API Specification

BangDori edited this page Apr 12, 2024 · 24 revisions
κΈ°λŠ₯ λ©”μ„œλ“œ URI λΉ„κ³ 
νŒ”λ‘œμš° μš”μ²­ POST /users/{user_id}/follow ⚠️
μ‚¬μš©μž 검색 GET /users ⚠️
μ‚¬μš©μž ν”„λ‘œν•„ 쑰회 GET /users/{user_id} ⚠️
  • βœ…: 확인 μ™„λ£Œ
  • ⚠️: λŒ€κΈ° μƒνƒœ
  • ❌: λ…Όμ˜ ν•„μš”

νŒ”λ‘œμš° μš”μ²­

// request
interface Request {
  user_id: number | string;
}

// response: 성곡 | μ‹€νŒ¨ 응닡 μ½”λ“œ

μ‚¬μš©μž 검색

μ“°λ‘œν‹€λ§μœΌλ‘œ 할거냐, λ””λ°”μš΄μŠ€λ‘œ 할거냐, μ•„λ‹ˆλ©΄ λͺ¨λ“  μž…λ ₯에 λŒ€ν•΄ 검색할 거냐?

// request
// μ‚¬μš©μž + (κ²Œμ‹œλ¬Ό 검색 - ν˜„μž¬λŠ” μ—†μ§€λ§Œ μΆ”ν›„ λ“±λ‘λœλ‹€λ©΄?)
`/search/top?q=${}`

// (κ²Œμ‹œλ¬Ό 검색 - ν˜„μž¬λŠ” μ—†μ§€λ§Œ μΆ”ν›„ λ“±λ‘λœλ‹€λ©΄)
`/search/posts?q=${}`

// 일반 μ‚¬μš©μž 검색
`/search/users?q=${}`

// μ’‹μ•„μš” μ‚¬μš©μž κ²€γ……κ°œ
`/search/like?q=${}`

// response
interface Response {
    users: User[]
}

μ‚¬μš©μž ν”„λ‘œν•„ 쑰회

// request
interface Request {
  user_id: number | string;
}

// respnose
interface Response {
  user: User;
  feeds: Feed[];
  is_follow: boolean; // νŒ”λ‘œμš° μ—¬λΆ€λ₯Ό user에 λ„£λŠ”κ²Œ λ§žλŠ”μ§€, μ•„λ‹ˆλ©΄ λΆ„λ¦¬ν•˜λŠ”κ²Œ λ§žλŠ”μ§€ μ• λ§€ν•˜λ‹€!
}