spring | spring boot

spring boot 에서 swagger 사용하기 +)버전오류

socialcomputer 2022. 2. 3. 16:58
반응형
 swagger는 spring에 API를 자동으로 문서화시켜준다.
implementation group: 'io.springfox', name: 'springfox-boot-starter', version: '3.0.0'

를  dependency에 추가해주면 된다. (그래들일 경우 -> build.gradle 파일에 )

+) 참고-https://mvnrepository.com/artifact/io.springfox/springfox-boot-starter

 

매번 Talend API Tester를 통해 작성하지 않아도 된다는 게 너무 좋다.

또한 다양한 어노테이션으로 swagger ui에 설명, 이름을 추가/변경하거나 body에 들어갈 기본값을 설정해줄 수도 있다. 

 

그러나 새로운 swagger와 spring이 버전이 바뀌면서 적용이 되지 않는 일이 발생한다. 그래서
 spring.mvc.pathmatch.matching-strategy=ANT_PATH_MATCHER

을 어플리케이션 설정에 추가해줘야 한다. ( application.properties 파일에)

 

 swagger가 만들어준 API문서를 어떻게 볼 수 있느냐, 실행 후 아래 주소로 이동하면 가능하다.
http://localhost:포트번호/swagger-ui/

 

반응형