Feed 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	⚠️
preSignedURL 요청	.	.	❌
S3 이미지 업로드	.	.	❌
S3 이미지 제거	.	.	❌

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

0️⃣ 타입 정의

interface Feed {
  id: string | number; // 🚨 질문 리스트 2

  user: {
    id: string | number; // 🚨 질문 리스트 2
    profileImage: string;
    name: string;
    relationshipStatus: "self" | "following" | "none"; // 🚨 질문 리스트 3
  };

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

  likeCount: number;
  commentCount: number;

  is_like: boolean;
  is_bookmark: boolean;

  updatedAt: string;
}

interface Comment {
  id: string | number; // 🚨 질문 리스트 2

  user: {
    id: string | number; // 🚨 질문 리스트 2
    profileImage: string;
    name: string;
    relationshipStatus: "self" | "following" | "none"; // 🚨 질문 리스트 3
  };

  content: string;
  updatedAt: string;
}

1️⃣ 피드 목록 조회

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

interface Response {
  code: "2000";
  data: {
    next: string | null; // 다음 페이지에 대한 링크 ex) /feeds?page=2
    feeds: Feed[]; // 0️⃣ Feed
  };
}

2️⃣ 피드 작성

interface Request {
  uri: "/feeds";
  method: "POST";
  body: {
    title: string;
    content: string;
    images: string[];
    scope: "public" | "friends" | "private";
  };
}

interface Response {
  code: "2000";
  data: {
    // 🚨 질문 리스트 1
  };
}

3️⃣ 피드 상세

interface Request {
  uri: "/feeds?feedId=";
  method: "GET";
  query: {
    feedId: string | number; // 🚨 질문 리스트 2
  };
  body: {};
}

interface Response {
  code: "2000";
  data: {
    feed: Feed; // 0️⃣ Feed
    comments: Comment[]; // 0️⃣ Comment
  };
}

4️⃣ 피드 수정

interface Request {
  uri: "/feeds/{feedId}";
  method: "PUT";
  body: {
    title: string;
    content: string;
    images: string[];
    scope: "public" | "friends" | "private"; // 🚨 질문 리스트 4
  };
}

interface Response {
  code: "2000";
  data: {
    // 🚨 질문 리스트 1
  };
}

5️⃣ 피드 삭제

interface Request {
  uri: "/feeds/{feedId}";
  method: "DELETE";
  body: {};
}

interface Response {
  code: "2000";
  data: {
    // 🚨 질문 리스트 1
  };
}

6️⃣ 피드 좋아요

interface Request {
  uri: "/feeds/{feedId}/like";
  method: "POST";
  body: {};
}

interface Response {
  code: "2000";
  data: {
    // 🚨 질문 리스트 1
  };
}

7️⃣ 피드 신고

interface Request {
  uri: "/feeds/{feedId}/report";
  method: "POST";
  body: {
    select: string; // 🚨 질문 리스트 5
    content: string; // 🚨 질문 리스트 6
    isBlind: boolean;
  };
}

interface Response {
  code: "2000";
  data: {
    // 🚨 질문 리스트 1
  };
}

🚨 질문 리스트

1. 작성 완료, 좋아요 성공, 신고 성공에 대한 응답 데이터는 무엇으로 설정해야 하나요?
2. 게시물, 유저와 같은 고유 Id 타입 확정 필요 (string vs bigint)
3. 팔로우 여부와 자기 게시물 여부에 대한 여부 체킹에 대한 방법
   • 변수 하나로 체크하는 방법 relationshipStatus: 'self' | 'following' | 'none'
   • 변수 두개로 체크하는 방법 isFollow: boolean isSelfFeed: boolean
4. 공개 범위 변수 명 어떤 걸로 정의하는게 좋을까
5. 신고하기 사유에 대한 변수명과 타입을 어떻게 설정하는 것이 좋을까?
6. 신고하기 내용에 대한 변수명을 뭐로 설정하는 것이 좋을까?

✍️ 피드백

1. user의 id는 정수값으로 설정된다.
2. API 응답 데이터는 스네이크 케이스가 아닌, 카멜 케이스로 사용된다. ✅