Springboot Swagger 연동

Swagger란

REST API를 편리하게 문서화해줌

관리 + 제3자가 편리하게 API 호출할 수 있도록 도와줌

프로젝트 유지보수 및 API 개발시 편리

API의 명세와 문서를 대신 작성해줌?

 

https://swagger.io/

API Documentation & Design Tools for Teams | Swagger

 

Springboot와 Swagger 연결

1. dependencies에 springfox-boot-starter 추가 (build.gradle 파일의 dependencies)

implementation group: 'io.springfox', name: 'springfox-swagger', version: '2.9.2'

 

2. SwaggerConfig 작성

훔 이건 몇번 더 써봐야 알듯

• cofig 파일의 annotation을 @Configuration 작성
• 만약 스프링부트 아니고 그냥 스프링 사용시
  • @Configuration + @EnableSwagger2 사용
• application.yml 파일에 아래처럼 추가 및 수정

spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher

 

 

3. 잘 연동됐는지 확인

Swagger 3.0 접속 주소 : http://localhost:8080/swagger-ui/
Swagger 2.0 접속 주소 : http://localhost:8080/swagger-ui.html

 

내경우는 Swagger 2.0인갑다

---

ㅋㅋ

내용이 없다고 느낀다면

그게 맞습니다 .. 아직 잘 몰겠음ㅎ

몇번 열심히 구르면서 알아가보겠소 ..