게시판 API - Yapp-17th/Android_2_Backend GitHub Wiki

Base URL

http://101.101.219.23/api/board-service/

Post Board

게시판 글 작성

Request

  • url

    /v1/board

  • method

    POST

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • request body

    {
        "title": "급하게 농구 용병 3명 구합니다! 빡겜러 환영",
        "content": "안녕하세요! 농구팀 ‘슬램덩크’ 입니다. 농구 좋아하는 친구들끼리 모여서하는 팀인데, 모든 인원이 다 모이는 게 쉽지가 않아서 13일에 열리는 번개 농구모임에 참여해주실 
                    농구 용병 3분을 구합니다! (합치면 총 10명) 다들 열심히 하는 편이라 빡겜하실 분 모셔요!! * 대관료 n빵 합니다. (2시간 기준, 인당 약 4000원) * 뒷풀이 참여 안 
                    하셔도 됩니다.",
        "category": 1,
        "city": 2,
        "userTag": 1,
        "recruitNumber": 3,
        "date": "2016-11-09T11:44:44.797",
        "place": "플래닛 체육관 1층"
    }
    
    Field Type Description Example Required
    title String 글 제목 O
    content String 글 내용 O
    category Long 모집 운동 타입 O
    city Long 모임 위치 O
    userTag Long 유저 특징 O
    recruitNumber String 모집 인원 수 O
    date LocalDateTime 마감 시간 O
    place String 모임 상세 장소 O

Response

  • success response

    • body

      {
        "status": 200,
        "responseType": "BOARD_POST_SUCCESS",
        "message": "글이 정상적으로 업로드 되었습니다",
        "success": true
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      responseType String Response Type "BOARD_POST_SUCCESS" O
      success boolean 성공 여부 true O
      message String "글이 정상적으로 업로드 되었습니다" O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success responseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시판 작성을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시판 작성을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시판 작성을 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "CATEGORY_NOT_FOUND" "카테고리를 찾을 수 없습니다" 운동 카테고리 선택이 올바르지 않은 경우
    400 false "TAG_NOT_FOUND" "사용자 유형을 찾을 수 없습니다" 사용자 유형 카테고리 선택이 올바르지 않은 경우
    400 false "ADDRESS_NOT_FOUND" "주소를 찾을 수 없습니다" 주소 카테고리 선택이 올바르지 않은 경우
    400 false "BOARD_TIME_INVALID" "모임 시간이 올바르지 않습니다." 선택한 모임 시간이 현재를 기준으로 과거인 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." POST가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Get Board List

홈 화면 게시글 리스트 가져오기

  • url

    /v1/board?page=1&size=20&sorting=deadline&category=1&category=2&category=3&address=1

  • method

    GET

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • query params

    method parameter Description Example Required
    size Integer 한 페이지 당 조회 갯 수 (default : 20)
    page Integer 조회할 페이지 번호 (default : 0)
    sorting String 조회할 글 정렬 방법(default:"latest") latest, remain, deadline
    category Long 운동 종목 필터링(default:전체 조회), 여러 값 가능 1, 2, 3
    city Long 모임 지역 조회(default:전체 조회), 여러 값 가능 1, 2, 3

Response

  • success response

    • body

      {
          "status": 200,
          "success": true,
          "message": "글 목록 조회 성공"
          "data": [
              {
                  "boardId": 1,
                  "hostId": 3,
                  "hostName": "짹짹",
                  "title": "급하게 농구 용병 3명 구합니다!",
                  "groupStatus": {
                      "code": 0,
                      "name": "모집 중"
                  },
                  "exercise": "농구",
                  "city": "은평구",
                  "isBookMark": true
              },
              {
                  "boardId": 2,
                  "hostId": 5,
                  "hostName": "퐁퐁달퐁",
                  "title": "같이 중랑천 달리실 분!",
                  "groupStatus": {
                      "code": 0,
                      "name": "모집 중"
                  },
                  "exercise": "달리기",
                  "city": "중랑구",
                  "isBookMark": false
              },
              ...
          ]
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 게시판 조회 성공 메세지 O
      data List 게시판 정보 리스트 O
      data.boardId Long 게시판 번호 1 O
      data.hostId Long 호스트 번호 1 O
      data.hostName String 호스트 닉네임 "짹짹sut O
      data.title String 게시판 제목 "같이 중랑천 달리실 분!" O
      data.groupStatus 게시판 state 0: 모집중, 1: 모집 완료, 2: 활동완료, 3: 모임취소 O
      data.groupStatus.code Integer state code 0 O
      data.groupStatus.name String state name "모집중" O
      data.exercise String 모집 운동 카테고리 "축구" O
      data.city String 모집 위치 "강남구" O
      data.isBookMark Boolean 북마크 활성화 여부 true/false O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시판 리스트 요청을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시판 리스트 요청을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시판 리스트를 요청하는 사용자가 데이터베이스에 없을 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Get Board Content

게시글 내부 가져오기

  • url

    /v1/board/{boardId}

  • method

    GET

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • path params

    variable type Description Required
    boardId Long 조회할 글 번호 O

Response

  • success response

    • body

      {
          "status": 200,
          "success": true,
          "message": "글 내용 조회 성공"
          "data": {
                  "boardId": 1,
                  "title": "급하게 농구 용병 3명 구합니다! 빡겜러 환영",
                  "groupStatus": {
                      "code": 0,
                      "name": "모집 중"
                  },
                  "exercise": "농구",
                  "city": "은평구",
                  "recruitNumber": 3,
                  "recruitedNumber": 2,
                  "content": "안녕하세요! 농구팀 ‘슬램덩크’ 입니다. 농구 좋아하는 친구들끼리 모여서하는 팀인데, 모든 인원이 다 모이는 게 쉽지가 않아서 13일에 열리는 번개 농구 
                              모임에 참여해주실 농구 용병 3분을 구합니다! (합치면 총 10명) 다들 열심히 하는 편이라 빡겜하실 분 모셔요!! * 대관료 n빵 합니다. (2시간 기준, 
                              인당 약 4000원) * 뒷풀이 참여 안 하셔도 됩니다.",,
                  "isBookMark": true,
                  "host":{
                      "hostId": 3,
                      "hostName": "짹짹",
                      "likes": 53,
                      "dislikes": 3
                  }
          }
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      message String 게시판 조회 성공 메세지 O
      data List 글 정보 O
      data.boardId Long 게시판 번호 1 O
      data.title String 게시판 제목 "같이 중랑천 달리실 분!" O
      data.groupStatus 게시판 state 0: 모집중, 1: 모집 완료, 2: 활동완료, 3: 모임취소 O
      data.code Integer state code 0 O
      data.name String state name "모집중" O
      data.exercise String 모집 운동 카테고리 "축구" O
      data.city String 모집 위치 "강남구" O
      data.recruitNumber Integer 총 모집 인원 3 O
      data.recruitedNumber Integer 현재 모집 인원 2 O
      data.content String 모집 글 내용 2 O
      data.isBookMark Boolean 북마크 여부 true/false O
      data.host 호스트 정보 O
      data.host.hostId Long 호스트 번호 1 O
      data.host.hostName String 호스트 닉네임 "짹짹" O
      data.host.likes String 호스트 좋아요 수 2 O
      data.host.dislikes String 호스트 싫어요 수 2 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시판 내용 요청을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시판 내용 요청을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시판 내용을 요청하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 요청한 게시글이 지워졌거나, 없는 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." GET이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Delete Board

게시글 삭제

  • url

    /v1/board/{boardId}

  • method

    DELETE

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • path params

    variable type Description Required
    boardId Long 삭제할 글 번호 O

Response

  • success response

    • body
      {
          "status": 200,
          "success": true,
          "message": "글 삭제 성공"
      }
      
    Field Type Description Example Required
    status integer HTTP STATUS CODE 200 O
    success boolean 성공 여부 true O
    message String 글 삭제 성공 메세지 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시판 삭제를 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시판 삭제를 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시판 삭제를 요청하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 삭제를 요청한 게시글이 지워졌거나, 없는 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." DELETE가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Edit Board

게시글 수정

  • url

    /v1/board/{boardId}

  • method

    PUT

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • path params

    variable type Description Required
    boardId Long 수정할 글 번호 O
  • request body

    {
        "title": "급하게 농구 용병 3명 구합니다! 빡겜러 환영",
        "content": "내용 무",
        "category": 2,
        "city": 1,
        "userTag": 3,
        "recruitNumber": 3,
        "date": "2016-11-09T11:44:44.797",
        "place": "플래닛 체육관 2층"
    }
    
    Field Type Description Example Required
    title String 글 제목 O
    content String 글 내용 O
    category Long 모집 운동 타입 O
    city Long 모임 위치 O
    userTag Long 유저 특징 O
    recruitNumber String 모집 인원 수 O
    date LocalDateTime 마감 시간 O
    place String 모임 상세 장소 O

Response

  • success response

    • body
      {
          "status": 200,
          "success": true,
          "message": "글 수정 성공",
          "data": {
                  "boardId": 1,
                  "title": "급하게 농구 용병 3명 구합니다! 빡겜러 환영",
                  "groupStatus": {
                      "code": 0,
                      "name": "모집 중"
                  },
                  "exercise": "농구",
                  "city": "은평구",
                  "recruitNumber": 3,
                  "recruitedNumber": 2,
                  "content": "안녕하세요! 농구팀 ‘슬램덩크’ 입니다. 농구 좋아하는 친구들끼리 모여서하는 팀인데, 모든 인원이 다 모이는 게 쉽지가 않아서 13일에 열리는 번개 농구 
                              모임에 참여해주실 농구 용병 3분을 구합니다! (합치면 총 10명) 다들 열심히 하는 편이라 빡겜하실 분 모셔요!! * 대관료 n빵 합니다. (2시간 기준, 
                              인당 약 4000원) * 뒷풀이 참여 안 하셔도 됩니다.",,
                  "isBookMark": true,
                  "host":{
                      "hostId": 3,
                      "hostName": "짹짹",
                      "likes": 53,
                      "dislikes": 3
                  }
          }
      }
      
    Field Type Description Example Required
    status integer HTTP STATUS CODE 200 O
    success boolean 성공 여부 true O
    message String 글 수정 성공 메세지 O
    data List 글 정보 O
    data.boardId Long 게시판 번호 1 O
    data.title String 게시판 제목 "같이 중랑천 달리실 분!" O
    data.groupStatus 게시판 state 0: 모집중, 1: 모집 완료, 2: 활동완료, 3: 모임취소 O
    data.code Integer state code 0 O
    data.name String state name "모집중" O
    data.exercise String 모집 운동 카테고리 "축구" O
    data.city String 모집 위치 "강남구" O
    data.recruitNumber Integer 총 모집 인원 3 O
    data.recruitedNumber Integer 현재 모집 인원 2 O
    data.content String 모집 글 내용 2 O
    data.isBookMark Boolean 북마크 여부 true/false O
    data.host 호스트 정보 O
    data.host.hostId Long 호스트 번호 1 O
    data.host.hostName String 호스트 닉네임 "짹짹" O
    data.host.likes String 호스트 좋아요 수 2 O
    data.host.dislikes String 호스트 싫어요 수 2 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시판 수정을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시판 수정을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시판 수정을 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "CATEGORY_NOT_FOUND" "카테고리를 찾을 수 없습니다" 운동 카테고리 선택이 올바르지 않은 경우
    400 false "TAG_NOT_FOUND" "사용자 유형을 찾을 수 없습니다" 사용자 유형 카테고리 선택이 올바르지 않은 경우
    400 false "ADDRESS_NOT_FOUND" "주소를 찾을 수 없습니다" 주소 카테고리 선택이 올바르지 않은 경우
    400 false "BOARD_TIME_INVALID" "모임 시간이 올바르지 않습니다." 선택한 모임 시간이 현재를 기준으로 과거인 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." PUT이 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Create BookMark

북마크 생성

Request

  • url

    /v1/board/bookmark

  • method

    POST

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • request body

    {
        "boardId": 1
    }
    
    Field Type Description Example Required
    boardId Long 북마크 글 아이디 O

Response

  • success response

    • body

      {
        "status": 200,
        "responseType": "BOOKMARK_POST_SUCCESS",
        "message": "북마크가 정상적으로 추가 되었습니다",
        "success": true
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      responseType String 메세지 "BOOKMARK_POST_SUCCESS" O
      success boolean 성공 여부 true O
      message String 북마크 추가 성공 메세지 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 북마크 요청을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 북마크 요청을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 북마크 요청을 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 삭제된, 또는 없는 게시글을 북마크 요청한 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." POST가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Delete BookMark

북마크 해제

Request

  • url

    /v1/board/{boardId}/bookmark

  • method

    DELETE

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • path params

    variable type Description Required
    boardId Long 북마크 해제할 글 번호 O

Response

  • success response

    • body

      {
        "status": 200,
        "responseType": "BOOKMARK_DELETE_SUCCESS",
        "message": "북마크가 정상적으로 삭제 되었습니다",
        "success": true
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      responseType String 메세지 "BOOKMARK_DELETE_SUCCESS" O
      success boolean 성공 여부 true O
      message String 북마크 삭제 성공 메세지 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 북마크 해제를 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 북마크 해제를 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 북마크 해제를 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 삭제된, 또는 없는 게시글을 북마크 해제한 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." DELETE가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Hide Board

게시물 숨김 처리

Request

  • url

    /v1/board/hidden

  • method

    POST

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • request body

    {
        "boardId": 1
    }
    
    Field Type Description Example Required
    boardId Long 게시글 ID O

Response

  • success response

    • body

      {
        "status": 200,
        "responseType": "HIDDEN_SUCCESS",
        "message": "게시물이 피드에서 숨김처리 되었습니다.",
        "success": true
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      responseType String 메세지 "HIDDEN_SUCCESS" O
      success boolean 성공 여부 true O
      message String 북마크 삭제 성공 메세지 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시글 숨김을 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시글 숨김을 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시글 숨김을 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 삭제된, 또는 없는 게시글을 숨김한 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." POST가 아닌 다른 메소드로 요청한 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류

Report Board

게시물 신고 처리

Request

  • url

    /v1/board/report

  • method

    POST

  • header

    method parameter Description Required
    Authorization Bearer {token} Bearer type access token O
  • request body

    {
        "boardId": 1,
        "reportType": 2,
        "content": "그냥"
    }
    
    Field Type Description Example Required
    boardId Long 게시글 ID O
    reportType Long 신고 이유 O
    content String 기타 선택 후 신고 이유

Response

  • success response

    • body

      {
        "status": 200,
        "responseType": "REPORT_SUCCESS",
        "message": "신고가 정상적으로 접수되었습니다.",
        "success": true
      }
      
      Field Type Description Example Required
      status integer HTTP STATUS CODE 200 O
      success boolean 성공 여부 true O
      responseType String 메세지 O
      message String 신고 성공 메세지 O
  • fail response

    {
        "status":{{Integer}},
        "success": {{Boolean}},
        "responseType": {{String}},
        "message": {{String}}
    }
    
    Field Type Description Example Required
    status integer HTTP STATUS CODE 500 O
    success boolean 성공 여부 false O
    responseType String 오류 실패 메세지 "USER_NOT_FOUND" O
    message String 오류 실패 메세지 "사용자를 찾을 수 없습니다" O
    status success ResponseType message 상황
    401 false "INACTIVE_USER_FAIL" "회원 가입이 필요합니다." 탈퇴한 사용자가 게시글 신고를 시도했을 경우
    403 false "SUSPENDED_USER_FAIL" "신고로 정지된 사용자입니다." 정지된 사용자가 게시글 신고를 시도했을 경우
    400 false "USER_NOT_FOUND" "사용자를 찾을 수 없습니다" 게시글 신고를 시도하는 사용자가 데이터베이스에 없을 경우
    400 false "BOARD_NOT_FOUND" "게시글을 찾을 수 없습니다" 삭제된, 또는 없는 게시글을 신고한 경우
    400 false "INVALID_METHOD" "메소드 유형이 잘못 되었습니다." POST가 아닌 다른 메소드로 요청한 경우, request body가 올바르지 않은 경우
    500 false "INTERNAL_SERVER_ERROR" "서버 내부 오류" 서버 내부 오류