[WIL계획]05.04~ 05.10 토이프로젝트 해보기 1차 계획

allnight5·2023년 5월 2일
0

WIL

목록 보기
20/20

해결한 프로그래머스 숫자 카드 나누기

토이 프로젝트 진행

RESTful API인 /api/news가 있다고 하겠습니다.
이 API의 입력과 결과 값으로 어떤 JSON 데이터가 와야 할까요?
기대하는 HTTP Status code와 JSON data 형식을 적어주세요.
Front-end를 지원한다고 가정하며 로그인상태는 신경쓰지 않아요.

위의 내용을 news라는 프로젝트를 진행합니다.

사용해야할 기술과 주의할점

  • QueryDsl과 프로젝션을 이용하여 쿼리최적화를 진행해야 합니다.
  • 정적 팩토리 메소드를 사용해야 합니다.
  • 작성된 메소드들의 테스트 코드를 작성해야 합니다.
  • 연관관계를 지어서 처리해야 합니다.
  • 이름을 통하여 메소드의 역할을 알 수 있게해야 합니다.
  • HTTP Status의 세분화를 해야 합니다.

news는 동영상, 이미지, 타이틀을 꼭 가지고있다.
news의 잠김은 기본적 으로는 잠겨있지 않습니다.

Get

어떤 형태의 Query를 이용하여 조회하여야 할까요?

  • 성공했다면 어떤 https status code와 결과를 되돌려 줘야 할까요?

GET /api/news

  • 만약 Query를 던졌는데 내용이 없다면 어떤 https status code와 결과를 되돌려 줘야 할까요?

GET /api/news/{news_id}

  • 만약 해당하는 Entity가 없다면 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 해당 Entity가 잠김으로 되어있다면 어떤 https status code와 결과를 되돌려 줘야 할까요?

Post

어떤 형태의 input을 이용하여 넣어줘야 할까요?

뉴스 작성
POST /api/news

  • 성공했다면 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 새롭게 생성한 Entity 가 기존에 있는 것과 충돌한다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 해당하는 Entity를 생성하다가 다른 내부 문제가 생겼다면 어떤 https status code와 결과를 되돌려 줘야 할까요?

Put

뉴스 수정
PUT /api/news/{news_id}

  • 성공적으로 Entity를 변경했다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 변경한 Entity의 내용의 일부가 받아들일 수 없는 내용이라면, 어떤 https status code와 결과를 되돌려 줘야 할까요?

PUT or PATCH /api/news/{news_id}/lock

  • 성공적으로 Entity를 변경했다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 해당 Entity가 이미 잠겨 있다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 해당 Entity가 없는 Entity라면, 어떤 https status code와 결과를 되돌려 줘야 할까요?

PUT or PATCH /api/news/{news_id}/unlock

  • 성공적으로 Entity를 변경했다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 해당 Entity가 이미 열려 있다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 해당 Entity가 없는 Entity라면, 어떤 https status code와 결과를 되돌려 줘야 할까요?

Delete

DELETE /api/news/{news_id}

  • 성공적으로 해당 Entity를 삭제했다면, 어떤 https status code와 결과를 되돌려 줘야 할까요?
  • 만약 삭제하려는 Entity가 없는 Entity라면, 어떤 https status code와 결과를 되돌려 줘야 할까요?

Error처리

  • 없는 url로 요청이 들어올때 어떤 https status code와 어떤 결과를 되돌려 줘야할까요?
  • /api/news/{news_id}/deletes이 요청 url일때 404의 https status code와 "Not Connection Url"이라는 메세지를 보내려면 어떻게 해야할까요?

참조할 사이트

상태코드 관련 MDN

profile
공부기록하기

0개의 댓글