부산대_3조_번개볼링_9주차 - Githubissues

Step3-kakao-tech-campus / Team3_BE

[카테캠 1기] 번개 지향 볼링 모집 커뮤니티 "번개볼링"의 백엔드 서버입니다.

2 stars 4 forks source link

부산대_3조_번개볼링_9주차 #115

Closed jagaldol closed 1 year ago

jagaldol commented 1 year ago

Summary

안녕하세요! 손민철 멘토님 부산대 3조 번개볼링 BE입니다. 9주차 코드리뷰 잘 부탁드립니다~ 😄

8주차 ~ 9주차 작업 내역입니다.

볼링장 api 추가
비밀번호 변경/찾기 api 추가
기존 api 버그 수정 및 개선
설정파일(application.yml) 통합 및 환경변수 적용
쿠버네티스를 사용한 크램폴린 배포
테스트 코드 작성 및 api 문서 배포(진행 중)

Description

8주차 ~ 9주차 작업내역 상세입니다.

API 추가

볼링장 API를 구현하였습니다.(#88)
- 외부 맵 API를 통해 원하는 볼링장을 찾고, 볼링장의 상세 이름과 해당 볼링장의 지역을 같이 api로 요청하면 상세 정보를 응답합니다.
- 해당 api는 구글맵 api를 사용합니다.
- 응답의 볼링장 이미지 url 정보에 secret key를 노출하지 않기 위해, redirect된 주소를 응답하도록 구현하였습니다.(#107)
비밀번호 변경 API와 비밀번호 찾기(초기화) API를 추가하였습니다.(#111)
- 비밀번호 찾기의 경우, 가입한 메일로 변경 요청 인증 메일을 보냅니다.
- 변경 요청 인증 메일을 통해 자신의 요청이 맞다고 링크를 클릭하면 초기화된 무작위 생성 비밀번호를 새로운 메일로 발송합니다.

API 개선

쪽지 목록 조회 api의 응답 누락을 고쳤습니다.(#77)
사용자 목록 검색 api에서 name(query parameter)을 필수가 아니도록 수정하였습니다.(#81)
개인정보 수정 api가 제대로 동작하고 있지 않은 점을 수정하였습니다.(#81)
점수API를 개선하였습니다.(#85)
- 요청보낸 사항에 대해서 수정을하지만, 이미지 필드를 다루기가 까다롭습니다.
- 점수 이미지 삭제의 경우 별도의 DELETE api를 추가하였습니다.
삭제된 댓글은 유저를 null로 가지고 있는 점에 대해 null 처리를 추가하였습니다.(#108)
회원가입 api에서 생성된 유저의 id를 반환하지 않고 있는 점을 수정하였습니다.(#109)

프로젝트 설정 관련

설정 파일(application.yml)을 environment variable을 사용하여 각 profile 별로 정리하였습니다.(#92)
CORS 정보를 environment variable로 관리하도록 개선하였습니다.(#101)

크램폴린 배포

크램폴린 배포를 위해 크램폴린 환경 테스트 및 쿠버네티스 설정 파일을 작성하였습니다.(#93)

테스트 및 api 문서 배포

멘토링 의견에 따라 테스트용 더미 데이터 teardown.sql을 만들어 환경 분리를 시켰습니다.(#75)
유저 컨트롤러 통합 테스트를 작성하였습니다.(#81)
행정구역 컨트롤러 통합 테스트를 작성하엿습니다.(#84)
restdocs-api-spec을 적용해 swagger ui를 생성하였습니다.(#89)
- 라이브러리를 적용하며 행정구역 컨트롤러를 문서화 진행하였습니다.
유저 컨트롤러를 문서화 완료하였습니다(#96)
댓글 컨트롤러 통합 테스트 코드 작성 및 문서화를 완료하였습니다.(#108, #109)

현재까지 작성된 api 문서는 https://bungae.jagaldol.dev:8080/api/docs/swagger 여기서 확인할 수 있습니다.

sososo0 commented 1 year ago

@MinChul-Son 부산대 3조 번개볼링 9주차 코드 리뷰입니다!