항해99 실전 프로젝트 (5일차)

---

DTO에서 객체 연관관계는 Id로 받는걸로 진행

네이버 코딩 컨벤션으로 진행

복수형은 List를 뒤에 붙히는 걸로

복수형으로 단어를 찾거나 확인하는 수고를 덜기 위해 List를 뒤에 붙히는게 좋다고 생각

최적의 이름길이

변수 이름의 길이가 평균적으로 10~16일 때 프로그램을 디버깅하기 위해서 들이는 노력을 최소화 할 수 있고, 변수의 평균 길이가 8~20인 프로그램은 디버깅하기가 쉽다.
  
모든 변수의 이름을 10~16의 길이로 작성하기 위해 애쓸 필요는 없겠지만, 길다면 그 이름이 적당한지 확인할 필요가 있다.
  
[너무 긴 이름]
numberOfPeopleOnTheUsOlympicTeam
numberOfSeatsInTheStadium
maximunNumberOfPointsInMordernOlympics
  
[너무 짧은 이름]
n, np, ntm
n, ns, nsisd
m, mp, max, points
  
[적당한 이름]
numTeamMembers, teamMemberCount
numSeatsInStadium, seatCount
teamPointsMax, pointsRecord

RESTful API

  
[GET]
200 - 정상
204 - 요청은 처리 됐지만 응답 본문이 없을 경우(일치 항목이 없는 검색 작업을 이 동작으로 구현)
404 - 리소스가 없을경우
  
[POST]
201 - 새 리소스 만들 경우 정상
200 - 처리를 수행하지만 새 리소스를 만들지 않을 경우
204 - 반환할 결과가 없어서 응답 본문이 없을 경우
400 - 잘못된 데이터를 요청 할 경우
  
[PUT]
201 - 새 리소스 만들 경우
200 - 기존 리소스 변경 됐을경우
204 - 변경 됐는데 응답 값 없을경우
409 - 업데이트를 못 할 경우
  
[PATCH]
415 - 지원되지 않는 미디어
400 - 잘못된 데이터 요청
409 - 패치 문서가 유효하지만 현재 상태에서는 변경 내용을 리소스에 적용 못함
  
[DELETE]
204 - 삭제 성공 응답 값 없을경우
404 - 리소스가 없을경우
  
[POST, PUT, PATCH 비교]
POST 요청은 리소스를 만듭니다.
PUT 요청은 리소스를 만들거나 또는 기존 리소스를 업데이트합니다.
PATCH 요청은 기존 리소스에 _부분 업데이트_를 수행합니다.

CRUD 명칭 통합

생성: create
수정: update
삭제: delete
1개 조회: get
특정 다수 조회: get … List … ById
전체 조회: getAll …
  
우리 팀의 우아한 타입스크립트 컨벤션 정하기 여정 | 우아한형제들 기술블로그
좋은 코드를 위한 JAVA 변수 네이밍
좋은 코드를 위한 자바 변수명 네이밍
웹 API 디자인 모범 사례 - Azure Architecture Center

MVP 공연장, 좌석, 등급 CRUD 서비스 구현완료