User API Specification

기능	메서드	URI	비고
팔로우 요청	POST	/users/{user_id}/follow	⚠️
팔로우 확인	GET	/users/{user_id}/follow	⚠️
사용자 검색	GET	/users?q=	⚠️
좋아요 사용자 검색	GET	/like?q=	⚠️
사용자 프로필 조회	GET	/users/{user_id}	⚠️
사용자 프로필 피드 조회	GET	/users/{user_id}?page=	⚠️

• ✅: 확인 완료
• ⚠️: 대기 상태
• ❌: 논의 필요

0️⃣ 타입 정의

interface User {
  id: number;
  profileImage: string;
  name: string; 
  content: string;
}

interface ProfileFeed {
  id: number; 
  title: string;
  content: string;
  thubnailImage: string;
};

1️⃣ 팔로우 요청

interface Request {
  uri: '/users/{user_id}/follow';
  method: 'POST';
  body : {}
}

interface Response {
  code: '2000';
  data: {};
}

2️⃣ 팔로우 확인

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

interface Response {
  code: '2000';
  data: {
    relationshipStatus: "self" | "following" | "none" | "pending";
  };
}

3️⃣ 사용자 검색

우선 모든 입력으로 진행, 추후 쓰로틀링 / 디바운스 도입 가능

interface Request {
  uri: "/users?q=";
  method: "GET"
  query:{
    q: string;
  }
  body: {};
}

interface Response {
  code: "2000";
  data:{
    users: User[] // 0️⃣ User
  }
}

4️⃣ 좋아요 사용자 검색

우선 모든 입력으로 진행, 추후 쓰로틀링 / 디바운스 도입 가능

interface Request {
  uri: "/like?q=";
  method: "GET"
  query:{
    q: string;
  }
  body: {};
}

interface Response {
  code: "2000";
  data:{
    users: User[] // 0️⃣ User
  }
}

5️⃣ 사용자 프로필 조회

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

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

6️⃣ 사용자 프로필 피드

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; // 다음 존재하는지
  }
}