Comment API 문서 - PartyGwam/api GitHub Wiki

Comment API

목차

GET /parties/<party_slug>/comments/

한 파티의 댓글 전체 조회

Response Format - Success

조회 성공시 다음의 데이터와 함께 200 응답을 리턴.
페이지 없이 한 응답에 모든 댓글 리턴.

  "success": true,
  "result": [
    {
      "id": 7,
      "author": {
        "username": "개발자",
        "profile_picture": null
      },
      "text": "오늘도 치킨 먹었다 개꿀띠",
      "slug": "개발자-오늘도-치킨-먹었다-개꿀띠",
      "created_at": "2018-07-01T17:29:06.415914+09:00",
      "last_updated": "2018-07-04T13:37:42.414989+09:00"
    },
    {
      "id": 9,
      "author": {
        "username": "개발자",
        "profile_picture": null
      },
      "text": "야 에란겔말고 사녹하자!",
      "slug": "개발자-야-에란겔말고-사녹하자",
      "created_at": "2018-07-01T20:46:10.961730+09:00",
      "last_updated": "2018-07-03T09:07:28.870945+09:00"
    },
    {
      "id": 11,
      "author": {
        "username": "개발자",
        "profile_picture": null
      },
      "text": "아 진짜 갓겜;;",
      "slug": "개발자-아-진짜-갓겜",
      "created_at": "2018-07-05T18:35:42.463551+09:00",
      "last_updated": "2018-07-05T18:35:42.463589+09:00"
    }
  ],
  "message": null
}

Response Format - Failure

  • 인증 토큰이 없는 경우 401 응답 리턴
  • 댓글이 없는 경우 404 응답 리턴

POST /parties/<party_slug>/comments/

파티에 댓글 작성

Request Format

댓글 내용만 보내면 됨.
작성자는 현재 로그인 된 유저로 자동 설정.

{
  "text": "개머리판 오지게 안나오네"
}

Response Format - Success

작성에 성공하면 다음 데이터와 함께 201 응답을 리턴.

{
  "success": true,
  "result": {
    "text": "개머리판 오지게 안나오네"
  },
  "message": null
}

Response Format - Failure

작성에 실패하면 실패 사유에 따라 4xx 응답을 리턴:

  • 401 : 인증 토큰이 없는 경우
  • 403 : 파티에 참여하지 않았는데 댓글을 작성하려 하는 경우

GET /parties/<party_slug>/comments/<slug>/

한 파티의 댓글 중 특정한 댓글 조회

Response Format - Success

성공 시 다음 데이터와 함께 200 응답을 리턴.

{
    "success": true,
    "result": {
        "id": 11,
        "author": {
            "username": "개발자",
            "profile_picture": null
        },
        "text": "아 진짜 갓겜;;",
        "slug": "개발자-아-진짜-갓겜",
        "created_at": "2018-07-05T18:35:42.463551+09:00",
        "last_updated": "2018-07-05T18:35:42.463589+09:00"
    },
    "message": null
}

Response Format - Failure

인증 토큰이 없는 경우 401 응답을 리턴.
해당 라벨의 댓글이나 파티가 존재하지 않는 경우 404 응답을 리턴.

PUT /parties/<party_slug>/comments/<slug>/

댓글 수정

Request Format

{
  "text": "string"
}

Response Format - Success

수정에 성공하면 다음 데이터와 함께 200 응답을 리턴.

{
    "success": true,
    "result": {
        "text": "아 진짜 갓겜ㅡㅡ"
    },
    "message": null
}

Response Format - Failure

수정에 실패하면 실패 사유와 함께 4xx 응답을 리턴:

  • 401 : 인증 토큰이 없는 경우
  • 403 : 현재 로그인된 유저가 댓글 작성자가 아닌 경우

DELETE /parties/<party_slug>/comments/<slug>/

댓글 삭제

Response Format - Success

삭제에 성공하면 응답 데이터 없이 204 응답을 리턴

Response Format - Failure

삭제에 실패하면 실패 사유와 함께 4xx 응답을 리턴:

  • 401 : 인증 토큰이 없는 경우
  • 403 : 현재 로그인된 유저가 댓글 작성자가 아닌 경우
⚠️ **GitHub.com Fallback** ⚠️