Skip to content

User API Specification

이의찬 edited this page May 21, 2024 · 24 revisions
κΈ°λŠ₯ λ©”μ„œλ“œ URI λΉ„κ³ 
μ‚¬μš©μž 쑰회 GET /users/{user_id} βœ…
μ‚¬μš©μžλ³„ ν”Όλ“œ 쑰회 GET /users/{user_id}/feeds?page= βœ…

1️⃣ μ‚¬μš©μž 쑰회

interface Request {
  uri: "/users/{user_id}";
  method: 'GET';
  body: {};
}

interface Response {
  code: "2000";
  data : {
    user: User; // 0️⃣ User
  }
}

2️⃣ μ‚¬μš©μžλ³„ ν”Όλ“œ 쑰회

interface Request{
  uri: "/users/{user_id}?page=";
  method: "GET";
  query: {
    page: string; // default = 1
  };
}

interface Response {
  code: "2000";
  data : {
    feeds: Feed[]; // 0️⃣ ProfileFeed 
    currentPageNumber: number; // ν˜„μž¬ νŽ˜μ΄μ§€μ˜ 수
    pageSize: number; // νŽ˜μ΄μ§€ 크기
    numberOfElements: number; // μ‹€μ œ λ°μ΄ν„°μ˜ 수
    hasNext: boolean; // λ‹€μŒ μ‘΄μž¬ν•˜λŠ”μ§€
  }
}