OurHomeRecipe / our-home-recipe-backend

우리집 레시피 백엔드입니다.
0 stars 2 forks source link

MemberController 테스트 코드 + 문서화 작업 일부 완료 #30

Closed pangwoo96 closed 1 week ago

pangwoo96 commented 1 week ago

️⃣ 연관된 이슈

closes #5 #11

️⃣ 작업 내용

  1. MemberController에 대한 테스트
  2. MemberControllerTest에 대한 문서화 (Rest Docs + SwaggerUI)

▷ 추가설명 ① 테스트 코드 작성 ② 테스트 코드에서 스니펫을 생성 (build/generated-snippets/) ③ RestAssuredRestDocumentationWrapper.document를 통해 생성된 스니펫을 openapi3 스펙의 yaml 파일로 변환, 생성 ④ SwaggerUI로 화면에 띄움

현재 상황은 이 과정이 전부 이루어지기는 합니다. 스니펫, memeber-openapi3.yaml 파일도 정상적으로 만들어지고 Swagger UI에 반영도 되지만 테스트가 안되는 상황입니다. 1차적으로 Swagger UI에서 Try it Out으로 테스트 해봤을 때 404에러가 발생 (API 미호출 의심) 2차적으로 만들어진 member-openapi3.yaml 파일에서 Try it Out 실행 시 똑같은 문제 발생 (API 미호출 의심) 아마도 테스트코드부터 다시 점검 해봐야 할 듯 합니다.

▷ 발생 이슈 SpringSecurity에서 경로를 제대로 설정하지 못했습니다. 임시적으로 antMatcher(GET, "/openapi-member.yaml"), antMatcher(POST, "/openapi-member.yaml") 해당 경로를 permitAll() 처리해서 Swagger UI에 접속은 가능했지만 확장성과 보안을 고려했을 때 수정 필요

️⃣ 테스트 결과

테스트 결과 전부 통과

️⃣ 변경 사항 체크리스트

️⃣ 스크린샷 (선택)

️⃣ 리뷰 요구사항 (선택)

📎 참고 자료 (선택)