[Spring] Swagger에 불필요한 컬럼이 보이는 원인 및 해결 방법

 

Swagger(Springdoc OpenAPI)에서 불필요한 컬럼이 보이는 이유는

API 응답에 DTO를 써야 하는데 Entity를 그대로 사용하기 때문이다.

 

❌ 문제

@GetMapping("/users/{id}")
public UserEntity getUser(@PathVariable Long id) {
    return userService.getUser(id);
}

UserEntity를 직접 반환하므로, Swagger에서 모든 필드(password, phoneNumber 등)가 API 문서에 포함된다.

 

✅ 해결법

→ Swagger에서 불필요한 컬럼이 보이면, Entity 대신 DTO를 사용하자

@GetMapping("/users/{id}")
public UserDto getUser(@PathVariable Long id) {
    UserEntity user = userService.getUser(id);
    return new UserDto(user.getUsername(), user.getEmail());
}

DTO를 사용하면 필요한 필드만 API 응답에 포함할 수 있음

 

---

 

 

✔️ 특정 필드 숨기는 법

 

@JsonIgnore를 사용하면 Swagger 문서에서 해당 필드를 제외할 수 있음

@JsonIgnore
private String password;

 

 

---

 

✔️ DAO, DTO, VO, Entity 차이

개념	역할	주요 사용처	특징
DAO	DB 접근 객체	`MyBatis`, `JPA`	DB 쿼리 실행
DTO	데이터 전달용	API 요청/응답	Swagger 문서화 시 사용
VO	불변 객체	특정 도메인 값 객체	`equals()` 오버라이드 필요
Entity	DB 테이블 매핑	`JPA`, `MyBatis`	모든 필드 포함 가능

 

[Spring] 스프링 헷갈리는 개념 정리 1. DAO, DTO, VO, Entity 차이