반응형
오늘은 우리 팀 프로젝트 MVP기능이 예상 기간보다 빠르게 끝나서 ( 주말,공휴일 활용 했으니,, ) 튜터님과 시간을 잡아서 코드리뷰 하는 시간을 가졌다.
💬 코드리뷰 (피드백)
코드리뷰를 해보니 각자 맡은 기능에서 잘 구현을 해주었지만, 이 코드는 조금만 더 효율적으로 해봤으면 어땟을까 라는 여러가지들의 의견을 받아 볼수 있어서 좋은 시간이 되었다.
내일 부터 피드백을 적용 시켜보는 시간을 가질 것 같다.
📅 추후 계획
- 이번주 목, 금까지 (~6/13)
- 코드 리뷰에서 피드백 받았던 내용 적용(리팩토링)
- 테스트 코드 작성
- Swagger 사용하여 API 명세서 작성
- 성능최적화 및 기능 고도화 완료 (~6/29)
- 다른 사람들이 서비스 이용할 수 있을 정도로
😀 Swagger
Swagger 라이브러리는 직접 써보니 굉장히 편하고 쉬웠다.
@Schema 어노테이션은 Dto 부분에 해당되어서 request와 response에서 가능하다. 이 어노테이션의 속성인 example로 swagger 사이트내에서 예시 값을 표현해줄수 있다. description은 설명이다.
컨트롤러에서는 다양한 어노테이션이 사용된다.
@Tag 어노테이션을 선언해 해당하는 속성에 name으로 제목을 지정하고, description으로 설명서를 작성해 해당 컨트롤러를 설명할 수 있다.
@Operation 어노테이션을 선언해 해당하는 컨트롤러에 만약 Get 메소드를 누르면, 속성에 summary 로 요약본과 description으로 설명서를 작성해줄수 있다.
@ApiResponse 어노테이션은 HttpStatus를 설정해주고, 해당 상태값이 어떤의미를 뜻하는지 Swagger에서 명시해줄수 있다.
결과적으로 깔끔한 api 명세서와 설명문이 들어와 있다.
반응형