들어가기전 Swagger와 OpenAPISpringfox-swagger vs Springdoc-openapi우리는 SpringDoc을 사용하자 !세팅 - 의존성 추가세팅 - security config 설정어디가 어떻게 변경되었을까?
들어가기전
- Open API와 OpenAPI 뭐가다름?
- Open API : 개방된 API로 누구나 사용될 수 있도록 API의 endpoint가 개방되어있다. ex) 우체국의 우편번호 API
- OpenAPI : OpenAPI Specipiation(OAS) 라고 부르며 이는 REST API를 정의된 규칙에 맞게 API 스펙을 json이나 yaml로 표현하는 방식이다.
- 즉 REST API 디자인에 대한 정의(Specification) 표준
Swagger와 OpenAPI
- 예전에는 Swagger 이름으로 불렸따가 2015년에 전환되어 OpenAPI 3.0 Specification으로 칭하게 되었다.
- OpenAPI = 사양, REST API 디자인에 대한 정의
- Swagger = 사양 구현을 위한 도구로 API 들이 갖고있는 specification을 정의할 수 있는 tool중 하나이다.
- 둘의 차이는?
- OpenAPI란?
Springfox-swagger vs Springdoc-openapi
- 공통점은?
- Swagger를 사용하고 API 문서를 쉽게 쓸 수 있도록 해준다.
- 스프링 프레임워크를 사용하는 프로젝트에서 사용하는 라이브러리
- Springfox
- 2018년까지 많은 사람들이 사용하다가 2018년 6월 업데이트가 중지되었다가 2020년 6월 새로운 버전을 출시함
- SpringDoc
- 2019년 7월 출시되어 업데이트가 없어진 springfox 대신에 사람들이 많이 사용하기 시작했다.
- webflux non-blocking 비동기 방식의 웹 개발을 지원한다.
우리는 SpringDoc을 사용하자 !
세팅 - 의존성 추가
세팅 - security config 설정
- Springfox와 달리 다른 config 설정을 해주지 않아도 된다.

- 기존의 yml 파일에 설정했던 팀 스웨거 정보이다. 이 부분의 위 코드의 .info(new Info().title(”instakyuram”))에 추가할 수 있다.
어디가 어떻게 변경되었을까?
- 기존의 코드(Spring fox)
- Spring Doc 사용된 코드