Skip to content

Comment API Specification

BangDori edited this page May 8, 2024 · 3 revisions
๊ธฐ๋Šฅ ๋ฉ”์„œ๋“œ URI ๋น„๊ณ 
๋Œ“๊ธ€ ์กฐํšŒ GET /feeds/{feed_id}/comments โœ…
๋Œ“๊ธ€ ์ž‘์„ฑ POST /feeds/{feed_id}/comments โœ…
๋Œ“๊ธ€ ๊ฐœ์ˆ˜ ์กฐํšŒ GET /feeds/{feed_id}/comments/count โœ…

1๏ธโƒฃ ๋Œ“๊ธ€ ์กฐํšŒ

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

interface Response {
  code: "2000";
  data: {
    comments: Comment[]; // 0๏ธโƒฃ Comment
    currentPageNumber: number; // ํ˜„์žฌ ํŽ˜์ด์ง€์˜ ์ˆ˜
    pageSize: number; // ํŽ˜์ด์ง€ ํฌ๊ธฐ
    numberOfElements: number; // ์‹ค์ œ ๋ฐ์ดํ„ฐ์˜ ์ˆ˜
    hasNext: boolean; // ๋‹ค์Œ ์กด์žฌํ•˜๋Š”์ง€
  };
}

2๏ธโƒฃ ๋Œ“๊ธ€ ์ž‘์„ฑ

interface Request {
  uri: "/feeds/{feed_id}/comments";
  method: "POST";
  body: {
    content: string;
  };
}

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

3๏ธโƒฃ ๋Œ“๊ธ€ ๊ฐœ์ˆ˜ ์กฐํšŒ

interface Request {
  uri: "/feeds/{feed_id}/comments/count";
  method: "GET";
  body: {};
}

interface Response {
  code: "2000";
  data: {
    totalCount: number;
  };
}