tuioe_5679 개발 삽질

Spring Boot로 API를 개발할 때 응답을 어떻게 반환할지에 대한 고민이 생깁니다 API 개발을 할때할 때 DB와 같이 사용하여 응답하도록 구현하는데 여기서 엔티티 자체를 반환한다면 불필요한 값도 같이 포함하여 반환하게 되기 때문에 비효율적인 방식입니다 또한 상태 코드나 헤더를 포함하여 반환해야 할 때도 존재합니다 이러한 문제점을 보완 하기 위해 DTO와 ResponseEntity를 같이 사용하게 되면 안정적이고 명확한 응답 처리가 가능합니다DTO(Data Transfer Object)란?API 요청/응답 전용 객체로 엔티티를 직접 노출하지 않고 필요한 데이터만 클라이언트 및 서버에 전달하는 역할을 합니다유지보수성과 안정성을 높여주며 많이 사용되는 방식입니다 다음과 같은 User 엔티티가 존재한다..

백엔드 개발에 주로 사용되는 Spring 프레임워크를 사용하여 간단한 Hello REST API를 만들어 보려고 합니다REST API는 무엇이고 기본 동작 원리에 대해 정리하려고 합니다REST (Representational State Transfer)자원을 URI로 구분하고 HTTP Method를 활용하여 CRUD를 수행하는 아키텍처 스타일입니다즉 어떤 자원(Resource)에 대해 무슨 행동(Method)을 할지 조합하여 API 설계하는 방식REST API 의 특징- 자원(Resource): /users, /blog/1 처럼 URI로 표현- 행위(Method): GET,POST,PUT,PATCH,DELETE 같은 HTTP Method 사용- 표현(Representation): JSON,XML 등으로 ..

Swagger란?REST API를 설계하고 문서화하여 테스트하는데 사용되는 프레임워크어노테이션을 통해서 쉽게 API 문서를 HTML으로 자동생성하는 기능을 제공하고 있습니다 프론트엔드와 같이 협업하는 과정에서 유용하게 활용할 수 있습니다 구현했던 API를 직접 문서로 작성할 필요 없이 Swagger를 사용하여 자동으로 생성한 API 문서로 확인하면 되기 때문에 편리하며 생산성 측면에 있어서 효율이 좋기 때문에 자주 사용되고 있습니다 Swagger 적용하기Spring Boot 버전에 따라서 적용하는 방법이 다르게 적용됩니다2.x 버전 이하는 springdoc-openapi 1.x 를 사용하여 프레임워크를 사용합니다 의존성 추가 (Gradle) dependencies { implementation 'o..