티스토리 뷰
코프링으로 개발 시 마주친 에러 관련 포스팅입니다.
개발 환경은 다음과 같습니다.
- Spring Boot Version : 2.4
- Java Version : 8
- Kotlin Version : 1.6.21
- springfox Version : 2.10.5
배경
쿼리스트링 내 prefix "is" 변수를 포함하고 있는 GET api를 만들고 있었습니다.
개발을 마치고 develop에 배포를 했는데, 프론트 개발자분이 스웨거에 해당 변수가 누락되었다고 알려주셨습니다.
처음엔 한글로 검색을 해보니 막막해서 포스팅하게 되었습니다.
다행히 springfox issue에 들어가니 다음과 같이 등록되어 있었습니다.
@ApiModelProperty on boolean field might be ignored with 'is' prefix in its name · Issue #3126 · springfox/springfox
Hello. I think @ApiModelProperty annotations is ignored on boolean fields, when the name of that field starts with 'is'. ex) @ApiModelProperty(...) private boolean started; // annotation will be us...
github.com
대충 읽어보니, prefix "is" 변수의 이름이 bean specification과 일치하기 때문에 springfox는 해당 변수를 찾을 수 없다고 하네요.
위 링크를 읽어보면 어떻게 처리했는지는 잘 모르겠습니다..
해결
저는 간단하게 prefix를 is로 가지는 컨벤션을 포기했습니다.
포기했던 이유는 kotlin은 변수명 뒤에 type을 적을 수 있기 때문에 is라는 prefix가 없어도 될거라 판단했습니다.
다른 해결 방법을 가지고 계시다면 댓글로 남겨주세요.
읽어주셔서 감사합니다.
'개발 노트' 카테고리의 다른 글
| git merge 옵션 squash (0) | 2023.08.10 |
|---|---|
| intellij에서 git 커밋 순서 바꾸기 (0) | 2023.08.02 |
| [코틀린] 두 날짜(LocalDateTime)의 일수 차이 코틀린스럽게 구하기 - ChronoUnit (0) | 2023.07.20 |
| [스프링+코틀린] spring boot 3 Class 'Foo' should have [public, protected] no-arg constructor (0) | 2023.07.20 |
| [스프링+코틀린] spring boot 3 webflux spring docs(swagger) 404 에러 (0) | 2023.07.15 |
- Total
- Today
- Yesterday
- 코테
- 이펙티브 자바
- 이팩티브 자바
- 클린 코드
- BAEKJOON
- Java
- 테라폼
- AWS
- Algorithm
- Olympiad
- 객체지향
- C++
- Kotlin
- 백준
- Effective Java
- 디자인패턴
- programmers
- kotest
- 프로그래머스
- JPA
- Spring
- 클린 아키텍처
- Spring Boot
- BOJ
- kkoon9
- node.js
- 알고리즘
- MSA
- 정규표현식
- 디자인 패턴
| 일 | 월 | 화 | 수 | 목 | 금 | 토 |
|---|---|---|---|---|---|---|
| 1 | ||||||
| 2 | 3 | 4 | 5 | 6 | 7 | 8 |
| 9 | 10 | 11 | 12 | 13 | 14 | 15 |
| 16 | 17 | 18 | 19 | 20 | 21 | 22 |
| 23 | 24 | 25 | 26 | 27 | 28 |