springboot

· Spring
스웨거RESTful API 서비스를 개발하고 문서화하는 데 도움을 주는 도구 모음API의 자동화된 문서를 생성하고 표시한다. 이를 통해 API 엔드포인트, 요청 및 응답 형식, 매개변수, 인증 등을 포함한 API의 세부 정보를 시각적으로 제공한다.간단한 UI를 제공함으로써, API를 테스트하고 상호작용할 수 있다.API를 기반으로 클라이언트 라이브러리 및 서버 스텁 코드를 자동으로 생성할 수 있다.개발자가 API를 테스트 하고 디버깅하는데 도움을 준다.  스웨거UI 설정 방법 (스프링부트 기준)1. MavenRepository 사이트에서 해당 의존성을 가져온다. (SpringDoc Open API UI)https://mvnrepository.com/artifact/org.springdoc/springdo..
임시로 디버깅하는 방법HttpEntity 클래스를 활용하여 body에 어떠한 JSON 값이 들어왔는지 확인한다. //회원가입 @PostMapping("") public void register(//@RequestBody UserRequest userRequest HttpEntity http){ log.info("user : {} ", http.getBody()); // 바디 값 확인 }정확한 request body의 내용이라기보다는 한번 더 캐스팅하여 사용해야하기 때문에 불편함이 있다.클라이언트에게 어떠한 값을 전달했는지 확인하기도 어렵다. 필터 적용하기로그를 찍어볼 수 있는 필터를 생성하여 확인한다...
API 예외처리는 어떻게 해야할까? API는 각 오류 상황에 맞는 오류 응답 스펙을 정하고, JSON으로 데이터를 내려주어야 한다. -> 각 통신마다 쓰는 방식이 다다르기 때문에 이를 공통적으로 약속(오류 응답 스펙)을 하고 사용해야 한다. 서블릿 API 예외처리 기존의 예외처리는 클라이언트가 예외를 발생했을 때 HTML 형태의 뷰템플릿을 반환했었다. 하지만, 클라이언트에서 API로 요청을 보내면 서버에서도 API로 반환해주어야 하는데 별도의 설정 없이 진행하게 되면 서버는 똑같이 뷰템플릿을 반환한다. API 예외처리 컨트롤러 @RestController public class ApiExceptionController { @GetMapping("/api/members/{id}") public Member..
thk_dev
'springboot' 태그의 글 목록