Spring Boot - REST API를 위한 snake_case 공통 설정

REST API 규격에 따라 일반적으로 CamelCase가 아닌 snake_case를 사용한다.

각각의 멤버 변수에 @JsonProperty를 적용하여 바꿔줄 수도 있지만, 설정파일을 이용해서 전체 프로젝트에 적용 할 수 도 있다.

 

방법 1. @JsonProperty

멤버 변수에 @JsonProperty 어노테이션을 붙여서 snake_case로 변경할 수 있다.

class User {
  @JsonProperty("user_id")
  private String userId;
}

 

방법 2. application.properties (또는 application.yaml) 설정

'방법 1'을 이용하면 매번 변수를 생성 할때마다 어노테이션을 추가해야하는 버거로움이 있다.

Spring 설정파일에 spring.jackson.property-naming-strategy 옵션에 SNAKE_CASE를 추가하면 프로젝트 전체에 적용된다.

 

application.properties

spring.jackson.property-naming-strategy=SNAKE_CASE

 

Header.java

public class Header<T> {

  private String transactionTime;

  private String resultCode;

  private String description;
}

 

아래와 같이 snake_case 형태로 출력된다.

적용 후