API Specification

피드

기능	메서드	URI	비고
피드 목록 조회	GET	/feeds	⚠️
피드 작성	POST	/feeds	⚠️
피드 상세	GET	/feeds/{feed_id}	⚠️
피드 수정	PUT	/feeds/{feed_id}	⚠️
피드 삭제	DELETE	/feeds/{feed_id}	⚠️
피드 좋아요	POST	/feeds/{feed_id}/like	⚠️
피드 신고	POST	/feeds/{feed_id}/report	⚠️
피드 이미지 업로드	POST	/feeds/{feed_id}/image	✨ 방법 논의 필요 (preSignedURL)
피드 이미지 제거	DELETE	/feeds/{feed_id}/image	✨ 방법 논의 필요

피드 목록 조회

• request: X
• response: Feed[]

피드 작성

// request
interface Request {
  title: string;
  content: string;
  images: string[]; // 프론트 업로드 or 서버 업로드 논의 필요
  scope: "public" | "friends" | "private";
}

// response: 성공 | 실패에 따른 응답 코드

피드 상세

• request: X
• response: Feed + Comment

interface Feed {
  id: string | number; // id 값을 string으로 설정하는지 number로 설정하는지?
  user: {
    // 게시물을 작성한 유저 정보
    id: string | number;
    profile_image: string;
    name: string;
    // 1. 팔로우 되었는지와 자기 게시물인지에 대한 여부를 변수 하나로 체킹한다.
    // ex)
    //    relationship_status: 'self' | 'following' | 'none'
    // 2. 각 상태를 변수로 분리한다.
    // ex)
    //    is_follow: boolean
    //    is_self_feed: boolean
  };

  title: string;
  content: string;
  images: string[];

  like_count: number;
  comment_count: number;

  is_like: boolean;
  is_bookmark: boolean;

  updated_at: string;
}

피드 수정

// request
interface Request {
  title: string;
  content: string;
  images: string[]; // 프론트 업로드 or 서버 업로드 논의 필요
  scope: "public" | "friends" | "private";
}

// response: 성공 | 실패 응답 코드

피드 삭제

// request
interface Request {
  feed_id: number | string; // number로 할지 string으로 할지, 서버에서 정해줘야함
}

// response: 성공 | 실패 응답 코드

피드 좋아요

// request
interface Request {
  feed_id: number | string; // number로 할지 string으로 할지, 서버에서 정해줘야함
}

// response: 성공 | 실패 응답 코드

피드 신고

// request
interface Request {
  feed_id: number | string; // number로 할지 string으로 할지, 서버에서 정해줘야함
}

// response: 성공 | 실패 응답 코드

피드 이미지 업로드 (presignedURL)

• 보류

피드 이미지 제거

• 보류

유저

기능	메서드	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에 넣는게 맞는지, 아니면 분리하는게 맞는지 애매하다!
}

• ✅: 확인 완료
• ⚠️: 대기 상태