API 명세

Index

1. 공통사항
   • API 사용시 유의점
   • Request header 형식
   • Response body 형식
   • 공통 예외 처리
     • 요청 parameter가 올바르지 않은 경우(400)
     • 요청한 데이터가 존재하지 않는 경우(404)
   • 페이징 처리
   • 이미지 처리
   • 중요사항

대분류	기능	method	URI
서버 상태 체크	서버 상태 체크	GET	/api/health, /chat/health
인증 관련	로그인	POST	/api/auth/login
	로그아웃	POST	/api/auth/logout
유저 관련	회원가입	POST	/api/users/join
	회원정보 조회(자기 자신 정보 조회)	GET	/api/users
	회원정보 조회	GET	/api/users/{user-id}
	회원정보 수정	PUT	/api/users
	닉네임 중복 체크	GET	/api/users/nickname
매너평가 관련	매너평가 하기	POST	/api/users/manner
	매너평가 조회	GET	/api/users/manner/{user-id}
카테고리 관련	카테고리 목록 조회	GET	/api/categories
	카테고리 한 건 조회	GET	/api/categories/{category-id}
물품 관련	물품 리스트 조회(회원 전용)	GET	/api/products
	물품 상세 정보 조회	GET	/api/products/{product-id}
	물품 등록	POST	/api/products
	물품 수정	PUT	/api/products/{product-id}
	물품 삭제	DELETE	/api/products/{product-id}
	물품 상태 변경	PUT	/api/products/state/{product-id}
	물품 끌어올리기	PUT	/api/products/refreshment/{product-id}
	물품 판매 내역 조회	GET	/api/products/sales-history
	물품 구매 내역 조회	GET	/api/products/purchase-history
찜하기 관련	찜한 상품 목록 조회	GET	/api/favorite-products
	찜하기 등록	POST	/api/favorite-products
	찜하기 삭제	DELETE	/api/favorite-products/{favorite-id}
	찜하기 삭제(물품 ID로)	DELETE	/api/favorite-products/products/{product-id}
거래 후기 관련	전체 후기 조회	GET	/api/sale-reviews/user/{user-id}
	판매자 후기 조회	GET	/api/sale-reviews/seller/{user-id}
	판매자 후기 등록	POST	/api/sale-reviews/seller
	판매자 후기 수정	PUT	/api/sale-reviews/seller/{sale-review-id}
	판매자 후기 삭제	DELETE	/api/sale-reviews/seller/{sale-review-id}
	구매자 후기 조회	GET	/api/sale-reviews/buyer/{user-id}
	구매자 후기 등록	POST	/api/sale-reviews/buyer
	구매자 후기 수정	PUT	/api/sale-reviews/buyer/{sale-review-id}
	구매자 후기 삭제	DELETE	/api/sale-reviews/buyer/{sale-review-id}
	받은 후기 숨기기	PUT	/api/sale-reviews/hide/{sale-review-id}
알림 관련	알림 목록 조회	GET	/api/notifications
	알림 읽음 처리	PUT	/api/notifications/{notification-id}
	알림 삭제 처리	DELETE	/api/notifications/{notification-id}
채팅 관련	채팅방 생성	POST	/api/chat-rooms
	채팅방 목록 조회	GET	/api/chat-rooms
	채팅방 상세 정보 조회	GET	/api/chat-rooms/{chat-room-id}
	판매중인 상품에 대한 채팅방 참여자 목록 조회	GET	/api/chat-rooms/product/{product-id}
	채팅방 초대하기	PUT	/chat/chat-rooms/invitation/{chat-room-id}
	채팅방 나가기	PUT	/chat/chat-rooms/exit/{chat-room-id}
	채팅이미지 생성	POST	/chat/messages/images
	채팅메시지 보내기	POST	/chat/messages
	채팅방 메시지 목록 조회	GET	/chat/messages
	읽은 메시지 갯수 갱신	PUT	/chat/messages/read-size

공통사항

API 사용시 유의점

• request 시 application/json 사용
• response 시 마찬가지로 content-type 을 application/json 으로 응답함

Request header 형식

• 회원 인증이 필요한 API의 경우 추가해야함(비회원 제외)

  key	type	value
  api_key	string	Bearer {jwt}

• api_key value의 예시

  Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJuaWNrTmFtZSI6ImtldmluX3N1Z28iLCJyb2xlcyI6WyJST0xFX1VTRVIiXSwiaXNzIjoiYWxnb3JpdGhtX3F1aXpfY3VyYXRvciIsImV4cCI6MTYyNzE5ODQwNSwiaWF0IjoxNjI3MTk0ODA1LCJ1c2VySWQiOiJ6b3JvXzI4MjUiLCJ1c2VyS2V5IjoyOH0.Ahl9IuevGfDTxxVlowf9RWAPPFcXKAsJuGLpXNTGYFxTlmWCBGl0Otgjn3LKslEynv8wo6yxuOZ1vvrJCWo-kw
  

Response body 형식

• 데이터 형식

  key	type	value
  success	boolean	응답성공시 true, 실패시 false
  response	Object	요청에 대응하는 결과 / 응답실패시 null
  error	Object	응답실패시 실패원인 및 HTTP에러코드와 잘못된 요청 필드 리스트 / 응답성공시 null

• 데이터 예시 (성공 응답)

  {
      "success": true,
      "response": {
          "응답 내용(스트링이 아니라 객체)"
      },
      "error": null
  }

  • 실제 요청했던 내용이 response 의 내용안에 들어있게 됨
• 데이터 예시 (실패 응답)

  {
      "success": false,
      "response": null,
      "error": {
          "message": "에러 내용",
          "status": 500,
          "invalid_fields": null
      }
  }

  • error.status 는 HTTP status code 이고 항상 500으로 고정되어 있는것이 아니라 에러 종류에 따라 바뀔 수 있음

공통 예외 처리

• API 명세와 관련없는 공통된 사항들을 정의합니다.

요청 parameter가 올바르지 않은 경우(400)

• Request 명세에서 required가 true인 필드(request body나 request param)를 넣지 않은 경우입니다.
• 아래와 같은 형태로 400 응답으로 내려줍니다.
  • 유효하지 않은 조건인 request body 필드는 invalid_fields에 있습니다.
• API 명세에서 '요청 parameter가 올바르지 않은 경우'는 별도의 실패 케이스로 정의하지 않습니다.

"error": {
    "message": "Bad request exception occurred",
    "status": 400,
    "invalid_fields": {
        "nickname": "nickname 값은 필수입니다.",
        "location": "location 값은 필수입니다."
    }
}

"error": {
    "message": "Required request parameter 'state' for method parameter type int is not present",
    "status": 400,
    "invalid_fields": null
}

요청한 데이터가 존재하지 않는 경우(404)

• 아래와 같은 형태로 404 응답으로 내려줍니다.
• API 명세에서 '요청한 데이터가 존재하지 않는 경우'는 별도의 실패 케이스로 정의하지 않습니다.

"error": {
    "message": "Could not found 'User' with query values (userId = 10)",
    "status": 404,
    "invalid_fields": null
}

"error": {
    "message": "Could not found 'ProductQueryDto' with query values (productId = 100)",
    "status": 404,
    "invalid_fields": null
}

페이징 처리

• 페이징 옵션이 필요한 경우 page, size를 추가 Query paramter로 전달한다.
• API 명세에 별도의 옵션이 없다면 기본 페이징 사이즈는 20, 데이터 정렬 기준은 id(PK) 기준 내림차순 정렬

Request 예시

• /api/products?page=2&size=2

이미지 처리

• 이미지 처리는 pre-signed URL을 사용한다.

물품 이미지 처리

• 물품 등록 요청 시 이미지 파일명을 함께 사용하는 경우 물품 이미지를 업로드할 수 있는 pre-signed URL을 발급한다.
• pre-signed URL을 사용해서 S3에 파일을 업로드하는 역할은 Client의 몫
• pre-signed URL을 사용해서 서버는 DB에 해당 경로를 저장해놓는다.
• 이후에 상세조회, thumb-nail 조회 등 이미지 조회 시 pre-signed URL에 실제 파일이 등록되어있지 않은 경우 404 응답이 나간다 (S3 스펙)

중요사항

• 아래 API 문서에서 표현할 Response의 '성공' 항목은 실제 응답의 response 부분만을 표기한다. (success, error는 표기하지 않음)
• 아래 API 문서에서 표현할 Response의 '실패' 항목은 실제 응답의 error 부분만을 표기한다. (success, response는 표기하지 않음)
• 회원 인증이 필요하지 않은 API는 별도로 회원 인증이 필요하지 않은 API라고 기입한다.
  • API 명세에 '회원 인증이 필요하지 않은 API'라는 내용이 없다면 회원 인증이 필요한 API로 Request Header에 Jwt 추가 필요.

---

서버 상태 체크

• 회원 인증이 필요하지 않은 API
• 서버 상태 체크 API

URL

• API 서버: GET /api/health
• CHAT 서버: GET /chat/health

Request

Request 예시

Response

• 성공(200)
  • 현재 timestamp를 리턴한다.

{
    "response": 1650430789815
}

Login

• 회원 인증이 필요하지 않은 API
• 회원가입을 한 사용자는 로그인을 할 수 있다.
• 유의사항
  • 사용자가 최초 가입 후 회원정보 수정 API를 통해 프로필 이미지를 등록하지 않으면 유효하지 않은 presigned-url이 발급된다.
    • 해당 경로로 접근시 404 리턴(AWS 스펙)

URL

• POST /api/auth/login

Request

param	type	required	description
access_token	body	true	카카오 로그인 API access_token

Request 예시

{
    "access_token": "yz6123kepyF2qasdfkar1234dGvQ321HrSasdfx0I2341PDZYigqe_04E40w"
}

Response

• 성공(200)

최초 로그인 시

{
    "api_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJvYXV0aElkIjoyMTcyNjMxOTY1LCJyb2xlcyI6WyJST0xFX1VTRVIiXSwiaXNzIjoiZGFhbmduLXNlcnZlciIsImlkIjo2LCJtYW5uZXIiOjM2LjUsImV4cCI6MTY1NTQ2MjM1MCwiaWF0IjoxNjU1NDU1MTUwfQ.1Vo1JK6vCVvxQDHGtVq7_pRK69MrsiKIF4wUrpK5wiYRE95kPu9zGbzxkr1utNR_-hSER-AV8bJ7v37RIPt2xw",
    "nickname": null,
    "location": null,
    "profile_url": null,
    "manner": 36.5
}

회원 정보 수정 후 로그인 시

{
    "api_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzUxMiJ9.eyJvYXV0aElkIjoyMTcyNjMxOTY1LCJyb2xlcyI6WyJST0xFX1VTRVIiXSwiaXNzIjoiZGFhbmduLXNlcnZlciIsIm5pY2tuYW1lIjoi7YWM7Iqk7Yq4IOuLieuEpOyehCIsImxvY2F0aW9uIjoi7ISc7Jq47IucIOqwleuPmeq1rCIsImlkIjoxLCJtYW5uZXIiOjM2LjUsImV4cCI6MTY1ODQ3NDI5OCwiaWF0IjoxNjU4NDY3MDk4fQ.C66bFI6MpcUSpyIAShWcUQTyVCnW0exxSMZyZ9viGlZlQk4yQnVOqJxEEuEly_uFBzQ4RDOCrqvUDcARnesAIA",
    "nickname": "테스트 닉네임",
    "location": "서울시 강동구",
    "profile_url": "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/profile-image/1/profile_image.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220722T051818Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220722%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=d7e7247053ba7b6fb0a92f35e62b983beba6839679609c269ac0e0d16b2841f3",
    "manner": 36.5
}

---

Logout

• 로그인한 사용자는 로그아웃을 할 수 있다.

URL

• POST /api/auth/logout

Request

param	type	required	description
access_token	body	true	카카오 로그인 API access_token

Request 예시

{
    "access_token": "yz6123kepyF2qasdfkar1234dGvQ321HrSasdfx0I2341PDZYigqe_04E40w"
}

Response

• 성공(200)

{
}

---

User

회원가입

• 회원 인증이 필요하지 않은 API
• 사용자는 회원가입을 할 수 있다.
  • 카카오 프로필 이미지 파일 경로에 접근하기 위해 presigned-url이 아닌 original-url을 리턴한다.
  • API 호출 결과로 profile_url을 받고 회원정보 수정 API 호출을 통해 프로필 이미지 등록을 위한 presigned-url을 발급받아야 한다.

URL

• POST /api/users/join

Request

param	type	required	description
access_token	body	true	카카오 로그인 API access_token

Request 예시

{
    "access_token": "yz6123kepyF2qasdfkar1234dGvQ321HrSasdfx0I2341PDZYigqe_04E40w"
}

Response

• 성공(200)

{
    "id": 1,
    "oauth_id": 2172631965,
    "profile_url": "http://k.kakaocdn.net/dn/64fac/btryDjlyt8p/QFcrbqBCShUTP5e7KQ6Pf1/img_640x640.jpg"
}

• 실패(401)
  • 유효하지 않은 토큰으로 요청 시

{
    "message": "401 Unauthorized: \"{\"msg\":\"this access token does not exist\",\"code\":-401}\"",
    "status": 401,
    "invalid_fields": null
}

회원정보 조회(자기 자신 정보 조회)

• 로그인한 사용자는 자기 자신의 정보를 조회할 수 있다.
• 유의사항
  • 조회 대상인 사용자가 최초 가입 후 회원정보 수정 API를 통해 프로필 이미지를 등록하지 않으면 유효하지 않은 presigned-url이 발급된다.
    • 해당 경로로 접근시 404 리턴(AWS 스펙)

URL

• GET /api/users

Request

• None

Response

• 성공(200)

{
    "id": 6,
    "oauth_id": 2172631965,
    "nickname": "테스트 닉네임",
    "location": "서울시 강동구",
    "profile_url": "https://BUCKET.com/profile-image/92a0d23d-6f1e-427c-8e7e-82629d3d08c7img_110x110.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220617T084453Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220617%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=6c9a5ad2a9472b3d8beb6b953f42fe4546a2032a6e74354d402255b147d84faa",
    "manner": 36.5
}

회원정보 조회

• 회원 정보를 조회할 수 있다.
• 유의사항
  • 조회 대상인 사용자가 최초 가입 후 회원정보 수정 API를 통해 프로필 이미지를 등록하지 않으면 유효하지 않은 presigned-url이 발급된다.
    • 해당 경로로 접근시 404 리턴(AWS 스펙)

URL

• GET /api/users/{user-id}

Request

• None

Response

• 성공(200)

{
    "id": 6,
    "oauth_id": 2172631965,
    "nickname": "테스트 닉네임",
    "location": "서울시 강동구",
    "profile_url": "https://BUCKET.com/profile-image/92a0d23d-6f1e-427c-8e7e-82629d3d08c7img_110x110.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220617T084453Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220617%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=6c9a5ad2a9472b3d8beb6b953f42fe4546a2032a6e74354d402255b147d84faa",
    "manner": 36.5
}

회원정보 수정

• 사용자는 회원정보를 수정할 수 있다.

URL

• PUT /api/users

Request

param	type	required	description
nickname	body	true	닉네임
location	body	true	지역 정보
profile_url	body	true	프로필 이미지("profile_image.jpg" 문자열 고정으로 .png, .jpeg, .jpg 확장자만 가능)

Request 예시

{
    "nickname": "테스트 닉네임",
    "location": "서울시 강동구",
    "profile_url": "profile_image.jpg"
}

Response

• 성공(200)

{
    "id": 1,
    "profile_url": "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/profile-image/1/profile_image.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220722T051703Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220722%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=7972a45e169c474e4f918b7fc01e68f4f4760aa8fb118cad80987f1312a13c3d"
}

닉네임 중복 체크

• 사용중인 닉네임 여부를 확인할 수 있다.

URL

• GET /api/users/nickname

Request

param	type	required	description
name	query string	true	중복 여부를 확인할 닉네임

Request 예시

• GET /api/users/nickname?name=테스트닉네임1
• GET /api/users/nickname?name=helloworld

Response

• 성공(200)
  • 존재하지 않는 닉네임인 경우

{
    "result": true
}

• 성공(200)
  • 이미 존재하는 닉네임인 경우

{
    "result": false
}

매너평가 하기

URL

• POST /api/users/manner

Request

param	type	required	description
user_id	body	true	유저 id
score	body	true	매너점수 (-5~5 사이의 정수)

Request 예시

{
    "user_id": 1,
    "score": 5
}

Response

• 성공(200)

{
}

• 실패(403)

{
    "message": "Authority error (cause: 자기 자신은 매너평가를 할 수 없습니다.)",
    "status": 403,
    "invalid_fields": null
}

매너평가 조회

• 사용자의 매너평가 정보를 조회할 수 있다.
  • 매너평가 점수 -5점 ~ 5점 중에 평가가 1건이상 존재하는 점수만 응답을 준다.

URL

• GET /api/users/manner/{user-id}

Request

• None

Response

• 성공(200)

{
    {
        "score": -5,
        "score_count": 2
    },
    {
        "score": -4,
        "score_count": 1
    },
    {
        "score": -3,
        "score_count": 1
    },
    {
        "score": -2,
        "score_count": 1
    },
    {
        "score": -1,
        "score_count": 1
    },
    {
        "score": 1,
        "score_count": 1
    },
    {
        "score": 2,
        "score_count": 1
    },
    {
        "score": 3,
        "score_count": 1
    },
    {
        "score": 4,
        "score_count": 1
    },
    {
        "score": 5,
        "score_count": 2
    }
}

• 성공(200)
  • 사용자에 대한 매너평가가 하나도 없는 경우

{
    "score": 0,
    "score_count": 0
}

---

Category

카테고리 목록 조회

• 회원 인증이 필요하지 않은 API
• 사용자는 카테고리 목록을 조회할 수 있다.

URL

• GET /api/categories

Request

• None

Response

• 성공(200)

[
    {
        "id": 1,
        "name": "디지털기기"
    },
    {
        "id": 2,
        "name": "생활가전"
    },
    {
        "id": 3,
        "name": "가구/인테리어"
    },
    {
        "id": 4,
        "name": "유아동"
    },
    {
        "id": 5,
        "name": "생활/가공식품"
    },
    {
        "id": 6,
        "name": "유아도서"
    },
    {
        "id": 7,
        "name": "스포츠/레저"
    },
    {
        "id": 8,
        "name": "여성잡화"
    },
    {
        "id": 9,
        "name": "여성의류"
    },
    {
        "id": 10,
        "name": "남성패션/잡화"
    },
    {
        "id": 11,
        "name": "게임/취미"
    },
    {
        "id": 12,
        "name": "뷰티/미용"
    },
    {
        "id": 13,
        "name": "반려동물용품"
    },
    {
        "id": 14,
        "name": "도서/티켓/음반"
    },
    {
        "id": 15,
        "name": "식물"
    },
    {
        "id": 16,
        "name": "기타 중고물품"
    }
]

카테고리 한 건 조회

• 회원 인증이 필요하지 않은 API
• 사용자는 id에 해당하는 카테고리를 조회할 수 있다.

URL

• GET /api/categories/{category-id}

Request

• None

Response

• 성공(200)

{
    "id": 2,
    "name": "생활가전"
}

---

Product

물품 리스트 조회(회원 전용)

• 사용자는 물품 목록을 조회할 수 있다.
  • 회원으로 조회하는 경우 현재 로그인한 사용자의 위치와 일치하는 물품 목록만 최신 등록순으로 보여준다.
• 페이징 사이즈: 5

URL

• GET /api/products
• GET /api/products?title=맥북
• GET /api/products?category=3
• GET /api/products?category=1,2,3
• GET /api/products?title=맥북&category=5
• GET /api/products?title=맥북&category=1,2,5
• GET /api/products?min-price=120000
• GET /api/products?min-price=120000&max-price=null
• GET /api/products?title=맥북&category=1,2,5&min-price=120000
• GET /api/products?title=맥북&category=1,2,5&min-price=120000&max-price=null
• GET /api/products?title=맥북&category=1,2,5&max-price=150000
• GET /api/products?title=맥북&category=1,2,5&min-price=null&max-price=150000
• GET /api/products?title=맥북&category=1,2,5&min-price=null&max-price=null
• GET /api/products?title=맥북&category=1,2,5&min-price=120000&max-price=160000

Request

param	type	required	description
title	query string	false	판매글 제목
category	query string	false	카테고리 id(ex.1,2,3,4,5)
			e.g. 카테고리 1건 조회 시 - category=1
			e.g. 카테고리 2건 이상 조회 시 - category=1,2,3,4,5
min-price	query string	false	최소 가격
max-price	query string	false	최대 가격

Response

• 성공(200)

[
    {
        "id": 14,
        "title": "그램 팝니다",
        "location": "서울시 강동구",
        "price": 9999,
        "thumb_nail_image": null,
        "favorite_count": 3,
        "chatting_count": 2,
        "created_at": "2022-06-05T00:56:13.273674"
    },
    {
        "id": 13,
        "title": "맥북 팝니다",
        "location": "서울시 강동구",
        "price": 9999,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/7f10531b-bff3-4ac0-b185-4e89f820c764test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155616Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=c9ead73ed5a3b41cb536148ff0f3a5f048ab68298368c2a43c7edd75ba0e887d",
        "favorite_count": 0,
        "chatting_count": 0,
        "created_at": "2022-06-05T00:49:31.365339"
    }
]

• 실패(400)
  • 위치 정보 미등록 시

{
    "message": "물품 조회 시 위치 정보 등록이 필수입니다.",
    "status": 400,
    "invalid_fields": null
}

물품 상세 정보 조회

• 사용자는 물품 한 건에 대한 상세 정보를 조회할 수 있다.

URL

• GET /api/products/{product-id}

Request

• None

Response

• 성공(200)
  • productImage가 존재하지 않는 경우

{
    "id": 1,
    "seller": {
        "id": 1,
        "name": "테스트닉네임2"
    },
    "buyer": null,
    "category_id": 1,
    "name": "mockProduct1",
    "price": 10000,
    "title": "mockProduct 팝니다1",
    "description": "mockProduct1 description",
    "location": "노원구 상계동",
    "product_state": "판매중",
    "view_count": 5,
    "thumb_nail_image": null,
    "product_images": [],
    "favorite_count": 4,
    "chatting_count": 5,
    "is_favorite": true,
    "created_at": "2022-06-11T07:09:40.744419"
}

{
    "id": 1,
    "seller": {
        "id": 1,
        "name": "테스트닉네임2"
    },
    "buyer": {
        "id": 3,
        "name": "테스트닉네임4"
    },
    "category_id": 1,
    "name": "mockProduct1",
    "price": 10000,
    "title": "mockProduct 팝니다1",
    "description": "mockProduct1 description",
    "location": "노원구 상계동",
    "product_state": "판매중",
    "view_count": 5,
    "thumb_nail_image": null,
    "product_images": [],
    "favorite_count": 4,
    "chatting_count": 5,
    "is_favorite": true,
    "created_at": "2022-06-11T07:09:40.744419"
}

• 성공(200)
  • productImage가 존재하는 경우

{
    "id": 13,
    "seller": "테스트 닉네임",
    "seller_id": 6,
    "buyer": null,
    "category_id": 1,
    "name": "맥북",
    "price": 9999,
    "title": "맥북 팝니다",
    "description": "미중고 맥북 팝니다",
    "location": "서울시 강동구",
    "product_state": "판매중",
    "view_count": 5,
    "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/7f10531b-bff3-4ac0-b185-4e89f820c764test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155911Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=3fa60b260e7b6696b48ad2688a04b9fbbd44682d8f15a530df34be817446178f",
    "product_images": [
        "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/7f10531b-bff3-4ac0-b185-4e89f820c764test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155911Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=3fa60b260e7b6696b48ad2688a04b9fbbd44682d8f15a530df34be817446178f",
        "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/5363b1ea-b4da-40bc-aa39-482d65f48cc4test002.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155911Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=316ccd7b305bf609e2bace758e9d16a25205c081dc0bf7ecd831a879483fd9a9",
        "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/4022b8fc-cf2a-49d0-8e8d-83a1f0181474test003.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155911Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=57fbf0e52e407d4b4725983df350db6f4887815058404db98390fd2d24f85789"
    ],
    "favorite_count": 0,
    "chatting_count": 0,
    "is_favorite": true,
    "created_at": "2022-06-11T07:09:40.796542"
}

물품 등록

• 사용자는 물품을 등록할 수 있다.

URL

• POST /api/products

Request

param	type	required	description
category_id	body	true	카테고리 id(ex.1,2,3,4,5)
title	body	true	판매글 제목
price	body	true	가격
description	body	true	물품 설명
product_images	body	false	업로드 하고자 하는 파일명(확장자는 png, jpeg, jpg만 가능, 최대 업로드 갯수는 10개)

Request 예시

• 이미지 없이 등록하는 경우

{
    "category_id": 1,
    "title": "맥북 팝니다",
    "price": 9999,
    "description": "미중고 맥북 팝니다"
}

• 이미지와 함께 등록하는 경우

{
    "category_id": 1,
    "title": "그램 팝니다",
    "price": 9999,
    "description": "미중고 그램 팝니다",
    "product_images": ["test001.jpg","test001.png","test003.jpeg"]
}

Response

• 성공(200)

이미지 없이 등록하는 경우

{
    "product_id": 13,
    "product_images": []
}

이미지와 함께 등록하는 경우

{
    "product_id": 13,
    "product_images": [
        "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/e01f24b1-553f-4bc9-961d-15eb7401c5bctest001.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T152514Z&X-Amz-SignedHeaders=host%3Bx-amz-acl&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=4e4b7b3842e77e1be1fbee295d667585062ffac5ccbabf4ae9f2eee9b6c494aa",
        "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/00baf529-caf1-452d-b4a8-e1b74d1b92fftest002.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T152514Z&X-Amz-SignedHeaders=host%3Bx-amz-acl&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=53ff5c401770ae502b81e40ae86546709f14488ec29b4d36b19eb3a3c5c79ff1",
        "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/9362e993-f1fb-4e3f-b2dc-3630bc521b8dtest003.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T152514Z&X-Amz-SignedHeaders=host%3Bx-amz-acl&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=b16df75d1313d13398652cce6e84db2ee804a24028764b76cabe3d2e3a3f19f5"
    ]
}

• 실패(400)
  • 사용자가 자신의 위치와 닉네임을 등록하지 않고 물품을 등록한 경우

{
    "message": "판매자의 주소와 닉네임 정보는 필수입니다.",
    "status": 400,
    "invalid_fields": null
}

물품 수정

• 판매자는 물품 정보를 수정할 수 있다.

URL

• PUT /api/products/{product-id}

Request

param	type	required	description
category_id	body	true	카테고리 id(ex.1,2,3,4,5)
title	body	true	판매글 제목
price	body	true	가격
description	body	true	물품 설명

Request 예시

{
    "category_id": 1,
    "title": "맥북 팝니다",
    "price": 9999,
    "description": "미중고 맥북 팝니다"
}

Response

• 성공(200)

{
}

• 실패(403)
  • 판매자가 아닌 사용자가 물품 수정을 하려는 경우

{
    "message": "Authority error (cause: 물품 수정은 판매자만 가능합니다.)",
    "status": 403,
    "invalid_fields": null
}

물품 삭제

• 판매자는 물품 정보를 삭제할 수 있다.

URL

• DELETE /api/products/{product-id}

Request

• None

Response

• 성공(200)

• 실패(403)

{
    "message": "Authority error (cause: 물품 삭제는 판매자만 가능합니다.)",
    "status": 403,
    "invalid_fields": null
}

물품 상태 변경

• 판매자는 물품 상태를 변경할 수 있다.

URL

• PUT /api/products/state/{product-id}

Request

param	type	required	description
state	body	true	물품상태 (ex.0-숨기기,1-판매중,2-거래완료,3-예약중)
buyer_id	body	false	구매자 user_id

Request 예시

• 물품상태를 '숨기기', '판매중' 또는 '예약중'으로 변경하는 경우

{
    "state": 3
}

• 물품상태를 '거래완료'로 변경하는 경우

{
    "state": 2,
    "buyer_id": 1
}

Response

• 성공(200)

{
}

• 실패(400)
  • 물품상태를 '거래완료'로 바꿀 때 buyerId를 입력하지 않은 경우

{
    "message": "buyerId 값은 필수입니다.",
    "status": 400,
    "invalid_fields": null
}

• 실패(403)

{
    "message": "Authority error (cause: 물품 상태 변경은 판매자만 가능합니다.)",
    "status": 403,
    "invalid_fields": null
}

물품 끌어올리기

• 판매자는 물품 끌어올리기를 사용할 수 있다.
  • 5회까지 사용가능

URL

• PUT /api/products/refreshment/{product-id}

Request

• None

Response

• 성공(200)

{
}

• 실패(400)
  • 5회 이상 물품 끌어올리기를 사용하는 경우

{
    "message": "새로 고침은 5회이상 할 수 없습니다.",
    "status": 400,
    "invalid_fields": null
}

• 실패(403)

{
    "message": "Authority error (cause: 물품 끌어올리기는 판매자만 가능합니다.)",
    "status": 403,
    "invalid_fields": null
}

물품 판매 내역 조회

• 사용자는 자신의 판매 내역 물품을 상태별로 조회할 수 있다.

URL

• GET /api/products/sales-history?state=0
• GET /api/products/sales-history?state=1
• GET /api/products/sales-history?state=2

Request

param	type	required	description
state	query string	true	물품상태(0-숨기기, 1-판매중,2-거래완료)

Response

• 성공(200)
  • 물품상태 조회 조건이 '거래완료'인 경우 has_review가 true일 수 있다.
  • '거래완료' 외의 물품 상태 조회 조건은 has_review가 무조건 false 이다.

[
    {
        "id": 14,
        "title": "그램 팝니다",
        "location": "서울시 강동구",
        "price": 9999,
        "thumb_nail_image": null,
        "favorite_count": 3,
        "chatting_count": 2,
        "has_review": true,
        "created_at": "2022-06-05T00:56:13.273674"
    },
    {
        "id": 13,
        "title": "맥북 팝니다",
        "location": "서울시 강동구",
        "price": 9999,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/7f10531b-bff3-4ac0-b185-4e89f820c764test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155616Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=c9ead73ed5a3b41cb536148ff0f3a5f048ab68298368c2a43c7edd75ba0e887d",
        "favorite_count": 0,
        "chatting_count": 0,
        "has_review": true,
        "created_at": "2022-06-05T00:49:31.365339"
    }
]

물품 구매 내역 조회

• 사용자는 자신의 구매 내역을 조회할 수 있다.

URL

• GET /api/products/purchase-history

Request

• None

Response

• 성공(200)

[
    {
        "id": 14,
        "seller_id": 2,
        "title": "그램 팝니다",
        "location": "서울시 강동구",
        "price": 9999,
        "thumb_nail_image": null,
        "favorite_count": 3,
        "chatting_count": 2,
        "has_review": true,
        "created_at": "2022-06-05T00:56:13.273674"
    },
    {
        "id": 13,
        "seller_id": 2,
        "title": "맥북 팝니다",
        "location": "서울시 강동구",
        "price": 9999,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/7f10531b-bff3-4ac0-b185-4e89f820c764test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220604T155616Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220604%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=c9ead73ed5a3b41cb536148ff0f3a5f048ab68298368c2a43c7edd75ba0e887d",
        "favorite_count": 0,
        "chatting_count": 0,
        "has_review": false,
        "created_at": "2022-06-05T00:49:31.365339"
    }
]

---

FavoriteProduct

찜한 상품 목록 조회

• 사용자는 자신이 찜한 상품 목록을 조회할 수 있다.

URL

• GET /api/favorite-products

Request

• None

Response

• 성공(200)

[
    {
        "id": 3,
        "title": "WH-1000XM4 팝니다.",
        "location": "서울특별시 구로구 구로동",
        "price": 350000,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/c488cb78-fbc7-4527-b964-1594afa5e2e7WH_1.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220727T164512Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220727%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=966220682fd28eb16f6e09a5df5a6456f035ece11e20cd4819351aec778f3a13",
        "favorite_count": 1,
        "chatting_count": 0,
        "created_at": "2022-07-27T17:08:57"
    },
    {
        "id": 2,
        "title": "에센허브 티트리 아크네 데일리 워시 팔아요.",
        "location": "서울특별시 구로구 구로동",
        "price": 12000,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/a23ea5cf-bf7a-4282-b426-38ca313ae59a%E1%84%8B%E1%85%A6%E1%84%89%E1%85%A6%E1%86%AB%E1%84%89%E1%85%A7%E1%86%AF%E1%84%92%E1%85%A5%E1%84%87%E1%85%B3_1.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220727T164512Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220727%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=847c0131b37502fbd77f939be41bd99d9b763ee5e3be83c5e060c4998d4512a8",
        "favorite_count": 2,
        "chatting_count": 0,
        "created_at": "2022-07-27T16:56:09"
    },
    {
        "id": 4,
        "title": "뉴 클린스왑 에이 처분합니다~",
        "location": "서울특별시 구로구 구로동",
        "price": 24000,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/d9463672-abd6-4a92-8853-d283947d9761clean-swap_1.jpeg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220727T164512Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220727%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=342e57291ff30511c129cf029affe5b573d0e37181fd4e4ae2882730ddf74a74",
        "favorite_count": 1,
        "chatting_count": 0,
        "created_at": "2022-07-27T17:13:14"
    },
    {
        "id": 7,
        "title": "에어컨",
        "location": "서울특별시 구로구 구로동",
        "price": 50000,
        "thumb_nail_image": "https://BUCKET_NAME.s3.ap-northeast-2.amazonaws.com/product-image/c69c0660-b44f-43db-ab13-33376383ee48%E1%84%89%E1%85%B3%E1%84%8F%E1%85%B3%E1%84%85%E1%85%B5%E1%86%AB%E1%84%89%E1%85%A3%E1%86%BA%202022-07-27%20%E1%84%8B%E1%85%A9%E1%84%92%E1%85%AE%205.20.59.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220727T164512Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220727%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=fdc1ee9bc49307632faaf90b220d9e5b7f8d00f2c6799cf390b15701f893c1b8",
        "favorite_count": 1,
        "chatting_count": 1,
        "created_at": "2022-07-27T17:21:42"
    }
]

찜하기 등록

• 사용자는 원하는 물품을 찜할 수 있다.

URL

• POST /api/favorite-products

Request

param	type	required	description
product_id	body	true	물품 id

Request 예시

{
    "product_id": 1
}

Response

• 성공(200)

{
    "favorite_id": 8
}

찜하기 삭제

• 사용자는 자신이 찜한 물품을 삭제할 수 있다.

URL

• DELETE /api/favorite-products/{favorite-id}

Request

• None

Response

• 성공(200)

• 실패(403)

{
    "message": "Authority error (cause: 찜하기를 누른 본인만 찜하기를 삭제할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

찜하기 삭제(물품 ID로)

• 사용자는 자신이 찜한 물품을 삭제할 수 있다.

URL

• DELETE /api/favorite-products/products/{product-id}

Request

• None

Response

• 성공(200)

---

SaleReview

전체 후기 조회

• 사용자가 받은 전체 후기를 조회할 수 있다.

URL

• GET /api/sale-reviews/user/{user-id}

Request

• None

Response

• 성공(200)

param	type	description
review_type	Integer	리뷰 타입 (0: 판매자 후기, 1: 구매 후기)

{
    "id": 4,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰4",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.481689"
},
{
    "id": 3,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰3",
    "review_type": 1,
    "created_at": "2022-06-17T14:29:35.478303"
},
{
    "id": 2,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰2",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.475205"
},
{
    "id": 1,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰1",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.469625"
}

판매자 후기 조회

• 사용자가 받은 판매자 후기를 조회할 수 있다.

URL

• GET /api/sale-reviews/seller/{user-id}

Request

• None

Response

• 성공(200)

param	type	description
review_type	Integer	리뷰 타입 (0: 판매자 후기, 1: 구매 후기)

{
    "id": 4,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰4",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.481689"
},
{
    "id": 3,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰3",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.478303"
},
{
    "id": 2,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰2",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.475205"
},
{
    "id": 1,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰1",
    "review_type": 0,
    "created_at": "2022-06-17T14:29:35.469625"
}

판매자 후기 등록

• 거래 완료한 구매자에 대한 판매자 후기를 남길 수 있다.

URL

• POST /api/sale-reviews/seller

Request

param	type	required	description
product_id	body	true	물품 ID
buyer_id	body	true	구매자 ID
content	body	true	후기 내용

Request 예시

{
    "product_id": 13,
    "buyer_id": 1,
    "content": "판매자 후기입니다."
}

Response

• 성공(200)

{
    "sale_review_id": 1
}

• 실패(400)

{
    "message": "리뷰를 남기는 사용자는 주소와 닉네임이 필수입니다.",
    "status": 400,
    "invalid_fields": null
}

• 실패(403)

{
    "message": "Authority error (cause: 올바른 요청이 아닙니다. 실제 판매자와 구매자만 리뷰를 남길 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

판매자 후기 수정

• 사용자는 자신이 작성한 판매자 후기를 수정할 수 있다.

URL

• PUT /api/sale-reviews/seller/{sale-review-id}

Request

param	type	required	description
content	body	true	후기 내용

Request 예시

{
    "content": "판매자 후기 수정입니다."
}

Response

• 성공(200)

판매자 후기 삭제

• 사용자는 자신이 작성한 판매자 후기를 삭제할 수 있다.

URL

• DELETE /api/sale-reviews/seller/{sale-review-id}

Request

• None

Response

• 성공(200)

구매자 후기 조회

• 사용자가 받은 구매자 후기를 조회할 수 있다.

URL

• GET /api/sale-reviews/buyer/{user-id}

Request

• None

Response

• 성공(200)

param	type	description
review_type	Integer	리뷰 타입 (0: 판매자 후기, 1: 구매 후기)

{
    "id": 4,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰4",
    "review_type": 1,
    "created_at": "2022-06-17T14:29:35.481689"
},
{
    "id": 3,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰3",
    "review_type": 1,
    "created_at": "2022-06-17T14:29:35.478303"
},
{
    "id": 2,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰2",
    "review_type": 1,
    "created_at": "2022-06-17T14:29:35.475205"
},
{
    "id": 1,
    "reviewer_id": 1,
    "reviewer": "테스트닉네임1",
    "profile_url": null,
    "location": "노원구 상계동",
    "content": "테스트 리뷰1",
    "review_type": 1,
    "created_at": "2022-06-17T14:29:35.469625"
}

구매자 후기 등록

• 거래 완료한 판매자에 대한 구매자 후기를 남길 수 있다.

URL

• POST /api/sale-reviews/buyer

Request

param	type	required	description
product_id	body	true	물품 ID
seller_id	body	true	판매자 ID
content	body	true	후기 내용

Request 예시

{
  "product_id": 3,
  "seller_id": 1,
  "content": "구매자 후기"
}

Response

• 성공(200)

{
    "sale_review_id": 5
}

• 실패(400)

{
    "message": "리뷰를 남기는 사용자는 주소와 닉네임이 필수입니다.",
    "status": 400,
    "invalid_fields": null
}

• 실패(403)

{
    "message": "Authority error (cause: 올바른 요청이 아닙니다. 실제 판매자와 구매자만 리뷰를 남길 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

구매자 후기 수정

• 사용자는 자신이 작성한 구매자 후기를 수정할 수 있다.

URL

• PUT /api/sale-reviews/buyer/{sale-review-id}

Request

param	type	required	description
content	body	true	후기 내용

Request 예시

{
  "content": "구매자 후기 수정입니다."
}

Response

• 성공(200)

구매자 후기 삭제

• 사용자는 자신이 작성한 구매자 후기를 삭제할 수 있다.

URL

• DELETE /api/sale-reviews/buyer/{sale-review-id}

Request

• None

Response

• 성공(200)

받은 후기 숨기기

• 사용자는 자신이 받은 리뷰를 숨길 수 있다.

URL

• PUT /api/sale-reviews/hide/{sale-review-id}

Request

• None

Response

• 성공(200)

• 실패(403)

{
    "message": "Authority error (cause: 리뷰를 받은 사람만 받은 리뷰를 숨길 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

---

Notification

알림 목록 조회

• 사용자는 자신에게 온 알림 목록을 조회할 수 있다.

URL

• GET /api/notifications

Request

• None

Response

• 성공(200)

Response 필드 설명

• 물품 관련 항목인 product_id, price, title, thumb_nail_image과 리뷰 남긴 사용자 항목인 reviewer_id, nickname, profile_url은 동시에 나타나지 않는다. 한 쪽 필드가 채워져있는 경우 나머지 필드는 null
  • 알림 유형이 0인 경우, price, reviewer_id, nickname, profile_url이 null
  • 알림 유형이 1인 경우, reviewer_id, nickname, profile_url이 null
  • 알림 유형이 2인 경우, price가 null
  • 알림 유형이 3인 경우, product_id, price, title, thumb_nail_image는 null
• 추가로 알림 유형 0,1,2 중에 알림 유형 2에서만 price 항목을 사용한다.

field_name	description
id	알림 ID
noti_code	알림 유형에 해당하는 int 코드(0-찜한 상품이 거래 완료된 경우, 1-찜한 상품의 가격이 낮아진 경우, 2-판매자가 판매완료로 상태를 변경한 경우, 3-구매자가 구매후기를 남긴 경우)
noti_type	위의 알림 유형 코드에 해당하는 String
product_id	물품 id (알림 유형 0,1,2에서 사용된다.)
price	물품 가격 (알림 유형 1에서만 사용된다.)
title	물품 판매글 제목 (알림 유형 0,1,2에서 사용된다.)
thumb_nail_image	물품 썸네일 이미지 URL (알림 유형 0,1,2에서 사용된다.)
reviewer_id	리뷰를 남긴 사용자 ID (알림 유형 2, 3에서 사용된다.)
nickname	리뷰를 남긴 사용자의 닉네임 (알림 유형 2, 3에서 사용된다.)
profile_url	사용자의 프로필에 해당하는 이미지 URL (알림 유형 2, 3에서 사용된다.)
created_at	알림생성 일시
view	해당 알림 조회 여부를 나타낸다.

[
   {
        "id": 5,
        "noti_code": 3,
        "noti_type": "구매후기를 남긴 경우",
        "product_id": null,
        "price": null,
        "title": null,
        "thumb_nail_image": null,
        "reviewer_id": 2,
        "nickname": "테스트 닉네임1",
        "profile_url": "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/profile-image/test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220628T075436Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220628%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=cdb5b5d42ad3e2323efe94bb1b336932c06e2583cb38165a49a5c342521a1215",
        "created_at": "2022-06-28T16:51:56.748767",
        "view": true
    },
    {
        "id": 6,
        "noti_code": 2,
        "noti_type": "판매자가 판매완료로 상태를 변경한 경우",
        "product_id": 4,
        "price": null,
        "title": "mockProduct 팝니다3",
        "thumb_nail_image": null,
        "reviewer_id": 2,
        "nickname": "이재훈",
        "profile_url": "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/profile-image/1c50fadb-76db-4892-8d71-6ef517a1dd71img_110x110.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220725T154513Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220725%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=e4b041b043445e14937e8a7715fbc532859644ae11800f83a1fa1e233c5498dc",
        "created_at": "2022-07-25T10:21:54",
        "view": false
    },
    {
        "id": 2,
        "noti_code": 0,
        "noti_type": "찜한 상품이 거래 완료된 경우",
        "product_id": 1,
        "price": null,
        "title": "mockProduct 팝니다3",
        "thumb_nail_image": "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/product-image/82c55a67-400f-4bef-8066-ecb65cd86582test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220628T075436Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220628%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=33dccbbc28f390025049ee10b697b28b11b8489f46154c52579d1a348f1fd312",
        "reviewer_id": null,
        "nickname": null,
        "profile_url": null,
        "created_at": "2022-06-28T16:50:44.333321",
        "view": false
    },
    {
        "id": 1,
        "noti_code": 1,
        "noti_type": "찜한 상품의 가격이 낮아진 경우",
        "product_id": 1,
        "price": 20000,
        "title": "mockProduct 팝니다3",
        "thumb_nail_image": "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/product-image/82c55a67-400f-4bef-8066-ecb65cd86582test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220628T075436Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220628%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=33dccbbc28f390025049ee10b697b28b11b8489f46154c52579d1a348f1fd312",
        "reviewer_id": null,
        "nickname": null,
        "profile_url": null,
        "created_at": "2022-06-28T16:49:52.600271",
        "view": false
    }
]

알림 읽음 처리

• 사용자는 '읽지 않음' 상태였던 알림을 '읽음' 상태로 바꿀 수 있다.

URL

• PUT /api/notifications/{notification-id}

Request

• None

Response

• 성공(200)

{
}

• 실패(403)
  • 자신이 받은 알림이 아닌데 읽음 처리를 시도한 경우

{
    "message": "Authority error (cause: 본인이 받은 알림만 읽음 처리할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

알림 삭제 처리

• 사용자는 자신이 받은 알림을 삭제할 수 있다.

URL

• DELETE /api/notifications/{notification-id}

Request

• None

Response

• 성공(200)

{
}

• 실패(403)
  • 자신이 받은 알림이 아닌데 삭제 처리를 시도한 경우

{
    "message": "Authority error (cause: 본인이 받은 알림만 삭제할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

---

Chat

채팅방 생성

• 사용자는 원하는 물품에 대해 채팅방을 생성할 수 있다.

URL

• POST /api/chat-rooms

Request

param	type	required	description
product_id	body	true	물품 id
other_user_id	body	true	상대방 ID

Request 예시

{
    "product_id": 5,
    "other_user_id": 1
}

Response

• 성공(200)

{
    "room_id": "62a992369d47a67cf5aaca76"
}

채팅방 목록 조회

• 사용자는 자신이 참여중인 채팅방 목록을 조회할 수 있다.
• 페이징 가능 / 최대 10개까지 조회

URL

• GET /api/chat-rooms

Request

• None

Response

• 성공(200)

Response 필드 설명

field_name	description
chat_room_id	채팅룸 ID
participant	채팅 상대방 닉네임
participant_image	채팅 상대방 프로필 이미지 URL (존재하지 않을 시 null)
location	채팅 상대방이 사는 주소
product_image	물품 이미지 URL (존재하지 않을 시 null)
last_chat	현재 채팅방에 있는 가장 최신 메시지
not_read_chat_count	현재 사용자가 읽지 않은 메시지 갯수
page_offset	'채팅방 메시지 목록 조회 API' 사용 시 페이징 시작하는 위치. 위로 스크롤 할 때 마다 page_offset - page_size로 offset을 변경하며 재요청하면 된다.
page_size	한 번에 채팅 메시지 불러오는 갯수
updated_at	채팅방 수정 일시

[
    {
        "chat_room_id": "62a992369d47a67cf5aaca76",
        "participant": "테스트닉네임1",
        "participant_image": null,
        "location": "노원구 상계동",
        "product_image": null,
        "last_chat": null,
        "not_read_chat_count": 0,
        "page_offset": 0,
        "page_size": 10,
        "updated_at": "2022-06-15T17:03:02.402"
    },
    {
        "chat_room_id": "62a980ec794e3f5281741e82",
        "participant": "테스트닉네임5",
        "participant_image": null,
        "location": "노원구 상계동",
        "product_image": null,
        "last_chat": "메시지 + 9",
        "not_read_chat_count": 10,
        "page_offset": 0,
        "page_size": 10,
        "updated_at": "2022-06-15T15:49:16.074"
    },
    {
        "chat_room_id": "62a980ec794e3f5281741e7f",
        "participant": "테스트닉네임4",
        "participant_image": null,
        "location": "노원구 상계동",
        "product_image": null,
        "last_chat": null,
        "not_read_chat_count": 0,
        "page_offset": 0,
        "page_size": 10,
        "updated_at": "2022-06-15T15:49:16.041"
    },
    {
        "chat_room_id": "62a980ec794e3f5281741e7c",
        "participant": "테스트닉네임3",
        "participant_image": null,
        "location": "노원구 상계동",
        "product_image": "https://project-club-bucket.s3.ap-northeast-2.amazonaws.com/product-image/5d329b04-ca13-4f0c-bdc9-4af74c457d55test001.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220615T105303Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220615%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=8705ef1e02d6326eb5dbaf57ea1a2b78e3f94158838b5a8b670a5cbe3c77d719",
        "last_chat": null,
        "not_read_chat_count": 0,
        "page_offset": 0,
        "page_size": 10,
        "updated_at": "2022-06-15T15:49:16.008"
    },
    {
        "chat_room_id": "62a980eb794e3f5281741e79",
        "participant": "테스트닉네임2",
        "participant_image": null,
        "location": "노원구 상계동",
        "product_image": null,
        "last_chat": null,
        "not_read_chat_count": 0,
        "page_offset": 0,
        "page_size": 10,
        "updated_at": "2022-06-15T15:49:15.977"
    },
    {
        "chat_room_id": "62a980eb794e3f5281741e76",
        "participant": "테스트닉네임1",
        "participant_image": null,
        "location": "노원구 상계동",
        "product_image": null,
        "last_chat": null,
        "not_read_chat_count": 0,
        "page_offset": 0,
        "page_size": 10,
        "updated_at": "2022-06-15T15:49:15.904"
    }
]

채팅방 상세 정보 조회

• 사용자는 채팅방 상세 정보를 조회할 수 있다.

URL

• GET /api/chat-rooms/{chat-room-id}

Request

• None

Response

• 성공(200)

Response 필드 설명

field_name	description
chat_room_id	채팅룸 ID
participant_id	채팅 상대방(이하 상대방) ID
participant_nickname	상대방 닉네임
participant_manner	상대방 매너온도
participant_image	상대방 프로필 이미지 URL (존재하지 않을 시 null)
out	상대방이 현재 채팅방을 나갔는지 여부
product_id	물품 ID
product_image	물품 이미지 URL (존재하지 않을 시 null)
product_price	물품 가격
product_title	물품 제목
product_name	물품 이름
product_state	물품 상태

{
    "chat_room_id": "62a980eb794e3f5281741e76",
    "participant_id": 1,
    "participant_nickname": "테스트닉네임1",
    "participant_manner": 36.5,
    "participant_image": null,
    "out": false,
    "product_id": 1,
    "product_image": null,
    "product_price": 10000,
    "product_title": "mockProduct 팝니다1",
    "product_name": "mockProduct1",
    "product_state": "판매중"
}

• 실패(403)
  • 자신이 참여하고 있지 않은 채팅방을 조회하는 경우

{
    "message": "Authority error (cause: 채팅방 참여자만 채팅방 상세 정보를 조회할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

판매중인 상품에 대한 채팅방 참여자 목록 조회

• 자신이 판매중인 상품에 대해 채팅방에 참여중인 구매자 목록을 조회할 수 있다.

URL

• GET /api/chat-rooms/product/{product-id}

Request

• None

Response

• 성공(200)

[
    {
        "id": 1,
        "name": "테스트 닉네임1"
    },
    {
        "id": 2,
        "name": "테스트닉네임2"
    },
    {
        "id": 3,
        "name": "테스트닉네임4"
    },
    {
        "id": 4,
        "name": "테스트닉네임3"
    },
    {
        "id": 5,
        "name": "테스트닉네임5"
    }
]

• 실패(403)
  • 자신이 판매중인 상품이 아닌 product에 대해 조회하는 경우

{
    "message": "Authority error (cause: 물품 판매자만 구매자 채팅방 목록을 조회할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

채팅방 초대하기

• 채팅방을 나간 상대방을 다시 초대할 수 있다.

URL

• PUT /chat/chat-rooms/invitation/{chat-room-id}

Request

param	type	required	description
user_id	body	true	초대하려는 사용자 ID

Request 예시

{
    "user_id": 1
}

Response

• 성공(200)

{
}

• 실패(400)

{
    "message": "자기 자신은 초대할 수 없습니다.",
    "status": 400,
    "invalid_fields": null
}

• 실패(403)
  • 자신이 참여하고 있지 않은 채팅방에 대해 API를 호출하는 경우
  • 채팅방에 참여하고 있지 않던 상대방을 초대하는 경우

{
    "message": "Authority error (cause: 채팅방 참여자만 채팅방에 초대할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

채팅방 나가기

• 채팅방을 나갈 수 있다.

URL

• PUT /chat/chat-rooms/exit/{chat-room-id}

Request

• None

Response

• 성공(200)

{
}

• 실패(403)
  • 자신이 참여하고 있지 않은 채팅방에 대해 API를 호출하는 경우

{
    "message": "Authority error (cause: 채팅방 참여자만 채팅방 나가기를 할 수 있습니다.)",
    "status": 403,
    "invalid_fields": null
}

채팅이미지 생성

• 채팅방에 메시지를 보낼 이미지에 대한 presigned-url을 미리 생성할 수 있다.

URL

• POST /chat/messages/images

Request

param	type	required	description
img_files	body	true	등록하고자 하는 이미지 파일명 배열. 최대 10개만 가능 .png, .jpeg, .jpg로 끝나는 데이터만 가능

Request 예시

{
    "img_files": ["test1.jpg", "test2.png", "test3.jpg", "하이.jpg", "바이.png"]
}

Response

field_name	description
origin_name	request body로 보냈던 파일명에 해당한다.
image_name	presigned_url을 써서 채팅 이미지 생성이후, 이미지를 채팅메시지 보내기 API를 써서 채팅 메시지로 보낼 때 사용한다.
	image_name 이 값을 사용해서 message_type은 3, message에 image_name을 넣으면 된다.
presigned_url	발급받은 이 값을 사용해서 해당 파일을 버킷 저장소에 등록하면 된다.

• 성공(200)

{
    "origin_name": "test1.jpg",
    "image_name": "15785614-e0e9-4d4f-97aa-9a09abb05a6dtest1.jpg",
    "presigned_url": "https://project-club-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/15785614-e0e9-4d4f-97aa-9a09abb05a6dtest1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220626T084527Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220626%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=20efb322e9ae20ccc939afd1f9e18352266b1d449d7b123b1c16ad84f5f0c924"
},
{
    "origin_name": "test2.png",
    "image_name": "9bda2650-8928-4ea1-bf8f-7e17e6412f64test2.png",
    "presigned_url": "https://project-club-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/9bda2650-8928-4ea1-bf8f-7e17e6412f64test2.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220626T084527Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220626%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=93ed08a46193cd5b79aab72d130bf14795b4774145136bb2ceb20f01817f0925"
},
{
    "origin_name": "test3.jpg",
    "image_name": "9ccf6567-f491-433f-97e4-69cb0a5f5a8atest3.jpg",
    "presigned_url": "https://project-club-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/9ccf6567-f491-433f-97e4-69cb0a5f5a8atest3.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220626T084527Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220626%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=ffb57aa75280c04e78d3ca0006e2e16cda7babfc00a2ca143506b52cacd342fb"
},
{
    "origin_name": "하이.jpg",
    "image_name": "fa23c269-d12f-46dc-9832-aed32bd88b0e하이.jpg",
    "presigned_url": "https://project-club-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/fa23c269-d12f-46dc-9832-aed32bd88b0e%ED%95%98%EC%9D%B4.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220626T084527Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220626%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=ae9d5c9f449d52d79c9b1bbfec49440e463bd24b141be316cd650753fc2fd41d"
},
{
    "origin_name": "바이.png",
    "image_name": "6d9c09b1-5feb-4d91-ab70-d41ac63c2383바이.png",
    "presigned_url": "https://project-club-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/6d9c09b1-5feb-4d91-ab70-d41ac63c2383%EB%B0%94%EC%9D%B4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220626T084527Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA45U7IOW6L%2F20220626%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=7e989666ef6c07ca086b121fdda7aaa34435ddc0b3d773a3ac8ae419ff913d04"
}

• 실패(400)
  • 올바르지 않은 데이터 형식 (좌표,이미지 메시지만 해당)

채팅메시지 보내기

• 채팅 메시지를 보낼 수 있다.

URL

• POST /chat/messages

Request

param	type	required	description
room_id	body	true	채팅룸 ID
sender_id	body	true	송신자 ID
receiver_id	body	true	수신자 ID
message_type	body	true	메시지 타입(1.일반메시지, 2.좌표 메시지, 3.이미지 메시지
message	body	false	메시지 내용(메시지 타입 1,2인 경우에만 사용하는 필드)
img_files	body(ARRAY)	false	전송할 이미지 리스트(메시지 타입 3인 경우에만 사용하는 필드)

• message_type 보충 설명
  • 일반 메시지: null, 공백문자, 빈 문자를 제외하고는 다른 제약 사항 X
  • 좌표 메시지: "X,Y" 형태로 comma 하나를 기준으로 두 개의 좌표 값이 들어와야 햔다.
  • 이미지 메시지: .png, .jpeg, .jpg로 끝나는 데이터만 가능. 이전에 채팅이미지 생성 API를 통해 이미지를 presignedUrl에 등록하고 image_name으로 받은 값을 넣어줘야 한다.
• message, img_files 보충 설명
  • message, img_files 두 필드는 동시에 사용할 수 없다. 메시지 타입에 맞는 한 필드만 사용해야 한다.

Request 예시

• 일반 메시지인 경우
  • message_type: 1

{
    "room_id": "62aa118d9de1944f4671f808",
    "sender_id":6,
    "receiver_id": 1,
    "message_type":1,
    "message":"테스트 메시지 입니다"
}

• 좌표 데이터인 경우 (X,Y)
  • message_type: 2

{
    "room_id": "62b8266645dc3e3c3c4d9c31",
    "sender_id":6,
    "receiver_id": 1,
    "message_type": 2,
    "message":"1123,2123"
}

• 이미지 데이터인 경우
  • message_type: 3

{
    "room_id": "62b96d2844b3907e8fb28a2d",
    "sender_id":6,
    "receiver_id": 1,
    "message_type":3,
    "img_files": ["c16de0a7-0c8c-44fb-a87e-8a7afe4fbb27test1.jpg","fc0a2cf6-2c88-4fae-bf1b-0f96481606dftest2.png","6b06d600-52a8-40f1-a328-4f6cb3df615dtest3.jpg","3d6e58d2-ff68-40e0-81f0-c5df4c2aeb37하이.jpg","21debba4-d5a5-4f4a-a9a9-4c17bbab4ce5바이.png"]
}

Response

• 성공(200)

{
}

• 실패(400)
  • 올바르지 않은 데이터 형식 (좌표,이미지 메시지만 해당)

{
    "message": "java.lang.IllegalArgumentException: 올바른 이미지 데이터 형식이 아닙니다.",
    "status": 400,
    "invalid_fields": null
}

{
    "message": "java.lang.IllegalArgumentException: 올바른 좌표 메시지 형식이 아닙니다.",
    "status": 400,
    "invalid_fields": null
}

채팅방 메시지 목록 조회

• 특정 채팅방 내 메시지들을 조회할 수 있다.
  • 채팅방 내 메시지들은 DB에 저장된 index를 기준으로 내림차순 조회
• 페이징 사이즈: 10(메시지는 10개씩 가져옴)
• 페이징 최솟값은 0(가장 예전데이터를 가지고 오고 싶은 경우)

URL

• GET /chat/messages?room_id=62a040c660c94648d2115371&page=50
• GET /chat/messages?room_id=62a040c660c94648d2115371&page=40
• GET /chat/messages?room_id=62a040c660c94648d2115371&page=30
• GET /chat/messages?room_id=62a040c660c94648d2115371&page=20
• GET /chat/messages?room_id=62a040c660c94648d2115371&page=10
• GET /chat/messages?room_id=62a040c660c94648d2115371&page=0

Request

param	type	required	description
room_id	query string	true	채팅방 ID
page	query string	true	채팅방 내 최신 메시지부터 가져오기 위한 offset. '채팅방 목록 조회' API 결과중에 page_offset를 초기값으로 사용하면 된다.

Response

Response 필드 설명

field_name	description
sender_id	채팅 메시지를 보낸 유저 ID
message_type	채팅메시지 타입. 채팅메시지 보내기 API에 정의한 내용과 일치한다.
message	채팅방 메시지 타입1,2(일반 메시지, 좌표 메시지)인 경우에만 들어있는 필드. 이미지 타입일 때 null을 반환
img_urls	채팅방 메시지 타입3(이미지 메시지)인 경우에만 들어있는 필드. 배열로 들어있고, 다른 타입일 때 null을 반환
created_at	메시지 생성일시

• 성공(200)

[
    {
        "sender_id": 6,
        "message_type": 2,
        "message": "123, 456",
        "img_urls": null,
        "created_at": "2022-06-27T18:17:13.608"
    },
    {
        "sender_id": 6,
        "message_type": 2,
        "message": "123,456",
        "img_urls": null,
        "created_at": "2022-06-27T18:17:11.112"
    },
    {
        "sender_id": 6,
        "message_type": 1,
        "message": "normal message normal message normal message normal message normal message",
        "img_urls": null,
        "created_at": "2022-06-27T18:09:41.338"
    },
    {
        "sender_id": 6,
        "message_type": 3,
        "message": null,
        "img_urls": [
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/c16de0a7-0c8c-44fb-a87e-8a7afe4fbb27test1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=2f747a45f9746911dd6c4a5d89357b1e5eea89567fe00d06eb3b5af998cf9402",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/fc0a2cf6-2c88-4fae-bf1b-0f96481606dftest2.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=ea45266547947eccefc1189891db66f4f5ba1a5e706f061b8eec11e2fc0321cc",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/6b06d600-52a8-40f1-a328-4f6cb3df615dtest3.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=011c1768a8a38df485be5af76ea59f5f672202040392fde31df27fb7fbefa024",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/3d6e58d2-ff68-40e0-81f0-c5df4c2aeb37%ED%95%98%EC%9D%B4.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=2bc9a4bd7188ac34ab1a6960b26763f5398c88533f45d8666607c97152c52b9a",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/21debba4-d5a5-4f4a-a9a9-4c17bbab4ce5%EB%B0%94%EC%9D%B4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=e81f87f87383f29af6f51d69ffd951d93c76d9ee12e429a1871b71c65f21ad01"
        ],
        "created_at": "2022-06-27T18:01:31.25"
    },
    {
        "sender_id": 6,
        "message_type": 3,
        "message": null,
        "img_urls": [
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/c16de0a7-0c8c-44fb-a87e-8a7afe4fbb27test1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=2f747a45f9746911dd6c4a5d89357b1e5eea89567fe00d06eb3b5af998cf9402",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/fc0a2cf6-2c88-4fae-bf1b-0f96481606dftest2.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=ea45266547947eccefc1189891db66f4f5ba1a5e706f061b8eec11e2fc0321cc",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/6b06d600-52a8-40f1-a328-4f6cb3df615dtest3.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=011c1768a8a38df485be5af76ea59f5f672202040392fde31df27fb7fbefa024",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/3d6e58d2-ff68-40e0-81f0-c5df4c2aeb37%ED%95%98%EC%9D%B4.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=2bc9a4bd7188ac34ab1a6960b26763f5398c88533f45d8666607c97152c52b9a",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/21debba4-d5a5-4f4a-a9a9-4c17bbab4ce5%EB%B0%94%EC%9D%B4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=e81f87f87383f29af6f51d69ffd951d93c76d9ee12e429a1871b71c65f21ad01"
        ],
        "created_at": "2022-06-27T18:00:54.63"
    },
    {
        "sender_id": 6,
        "message_type": 3,
        "message": null,
        "img_urls": [
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/c16de0a7-0c8c-44fb-a87e-8a7afe4fbb27test1.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=2f747a45f9746911dd6c4a5d89357b1e5eea89567fe00d06eb3b5af998cf9402",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/fc0a2cf6-2c88-4fae-bf1b-0f96481606dftest2.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=ea45266547947eccefc1189891db66f4f5ba1a5e706f061b8eec11e2fc0321cc",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/6b06d600-52a8-40f1-a328-4f6cb3df615dtest3.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=011c1768a8a38df485be5af76ea59f5f672202040392fde31df27fb7fbefa024",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/3d6e58d2-ff68-40e0-81f0-c5df4c2aeb37%ED%95%98%EC%9D%B4.jpg?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=2bc9a4bd7188ac34ab1a6960b26763f5398c88533f45d8666607c97152c52b9a",
            "https://cotchan-test-bucket.s3.ap-northeast-2.amazonaws.com/chat-image/21debba4-d5a5-4f4a-a9a9-4c17bbab4ce5%EB%B0%94%EC%9D%B4.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220627T091750Z&X-Amz-SignedHeaders=host&X-Amz-Expires=600&X-Amz-Credential=AKIA4EAIYFA4UNFHSYQQ%2F20220627%2Fap-northeast-2%2Fs3%2Faws4_request&X-Amz-Signature=e81f87f87383f29af6f51d69ffd951d93c76d9ee12e429a1871b71c65f21ad01"
        ],
        "created_at": "2022-06-27T17:47:11.641"
    },
    {
        "sender_id": 6,
        "message_type": 1,
        "message": "테스트 메시지 입니다",
        "img_urls": null,
        "created_at": "2022-06-27T17:43:40.243"
    }
]

읽은 메시지 갯수 갱신

• 사용자는 채팅방 내에서 자신이 읽은 메시지 갯수를 수정할 수 있다.
  • ex. 채팅방 화면을 끄는 경우 자신이 읽은 메시지 갯수 갱신

URL

• PUT /chat/messages/read-size

Request

param	type	required	description
room_id	body	true	채팅룸ID

Request 예시

{
    "room_id": "62a980eb794e3f5281741e76"
}

Response

• 성공(200)

{
}

• 실패(403)
  • 자신이 참여하고 있지 않은 채팅방에 대해 API를 호출하는 경우

{
    "message": "Authority error (cause: 자신이 참여중인 채팅방이 아닙니다.)",
    "status": 403,
    "invalid_fields": null
}