Swagger

springdoc openapi로 검색해 깃허브 페이지로 이동

https://github.com/springdoc/springdoc-openapi

GitHub - springdoc/springdoc-openapi: Library for OpenAPI 3 with spring-boot

springdoc-openapi-starter-webmvc-ui의 pom.xlm를 참고해 의존성 설치

이때 SNAPSHOT이 아닌 버전으로 하나 다운그레이드해서 사용하길 권장

		<dependency>
			<groupId>org.springdoc</groupId>
			<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
			<version>2.3.0</version>
		</dependency>

implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.3.0'

 

Spring Security를 사용한다면 경로 예외처리 필요

                            .requestMatchers(
                                    "/v3/api-docs/**",
                                    "/swagger-ui/**",
                                    "/swagger-resources/**",
                                    "/webjars/**"
                            ).permitAll()

 

확인

http://localhost:8080/swagger-ui/index.html

http://localhost:8080/v3/api-docs