Between-Departments / dev-BE

Between-Departments BE
0 stars 1 forks source link

게시글 작성 관련 API 형식 수정 요청입니다. #16

Closed H0onnn closed 11 months ago

H0onnn commented 11 months ago

안녕하세요 ! 개발 중 API req 형식에 대한 수정사항이 있어 이슈 남깁니다.

  1. 게시글 작성 (/api/posts)

현재 req body 형식이 아래와 같은데,

{ "title": "string", "content": "string", "major": "string", "category": "NEED_HELP", "anonymous": true }

게시글 작성에 이미지도 들어가기 때문에 images arr도 받을 수 있도록 추가 요청드립니다 !

  1. category 의 경우 '도움이 필요해요', '자유게시판' 을 분류하는 카테고리 항목으로 보이는데, 자유게시판에 글을 작성할 때 전체, 일상, 연애 등 상세 카테고리에 대한 처리는 어떻게 해야할지 문의드립니다 :)
L-ilac commented 11 months ago
  1. 반영했습니다.
  2. 카테고리 분류를 새롭게 변경했습니다.
    • boardType으로 '자유게시판' or '도움이 필요해요' 로 분류
    • '자유게시판'일 경우 tag로 상세 카테고리 설정
    • '도움이 필요해요'일 경우 major로 계열 설정
H0onnn commented 11 months ago

한가지 문의 사항이 있어 댓글 남깁니다 !

게시글 작성 API 요청 보낼 때 swagger 상의 모든 데이터 형식을 담아서 요청을 보내야 하나요 ?

예를 들어, 도움이 필요해요와 자유게시글의 필요한 데이터 형식이 상이한데, 이 때 모든 형식을 맞추되 필요 없는 데이터 (도움이 필요해요의 경우 tag 데이터)는 null로 담아서 보내드려야 하는지 혹은 아예 빈 값으로 처리해서 보내드려도 되는지 궁금합니다 !

ex)1 // 불필요 데이터를 null로 처리
{
  "title": "제목입니다",
  "content": "내용입니다. 그런데 10글자 이상의",
  "imageUrls": [
    "사진입니다"
  ],
  "major": "공학계열입니다",
  "boardType": "NEED_HELP",
  "tag": null,
  "anonymous": true
}

ex)2 // 불필요 데이터를 요청 본문에서 제외
{
  "title": "제목입니다",
  "content": "내용입니다. 그런데 10글자 이상의",
  "imageUrls": [
    "사진입니다"
  ],
  "major": "공학계열입니다",
  "boardType": "NEED_HELP",
  "anonymous": true
}
L-ilac commented 11 months ago

위의 예시를 참고하여 말씀드리면, 사실 둘 중 어떤 방식으로 보내던 백엔드 서버에서는 tag 값에는 null 값이 들어갑니다.

하지만, boardType에 따라 전송되는 데이터가 다르다는 것을 확실히 하기 위해서는 2번 예시로 보내주는게 좀 더 명확할 것 같긴 하네요.