Swagger
RestAPI를 설계, 빌드, 문서화 하는데 사용되는 라이브러리
Spring 프로젝트에 Swagger 적용하기
Spring 프로젝트에서 swagger를 사용하기 위한 라이브러리는 대표적으로 두가지가 있음.
1.
springfox swagger
2.
springdoc openAPI UI
두 라이브러리의 차이점은?
•
Springfox는 해당 라이브러리의 선발주자로서, 서칭 시 데이터를 찾기 좋다는 장점이 있지만, 2020년을 기점으로 업데이트되고 있지 않다.
•
Springdoc은 webflux라는 방식의 웹 개발을 지원하도록 개발되었다.
•
Springdoc은 설정파일을 통해 그룹간 api 정렬이 가능하다.
JAVA / Spring Boot 설정
Dependency
implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.4'
Java
복사
Config
@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI openAPI() {
Info info = new Info()
.version("v1.0.0")
.title("title")
.description("description");
return new OpenAPI().info(info);
}
}
Java
복사
Application.yml
springdoc:
api-docs:
version: openapi_3_0
Java
복사
