[Swagger3] SpringBoot SpringDoc(OpenAPI) Authorization 버튼 활성화 하는 방법

Swagger3 Authorization 버튼 활성화 하는 방법

---

프로젝트 진행 중 Swagger3를 사용해 API 테스트, 문서화를 했다.

이 과정에서 회원 서비스 관련해 Authorization 타입을 지정해줘야하는 API를 Swagger에서 테스트하기 위해 방법을 찾던 중 Authorization을 활성화 할 수 있다는 정보를 받았다.

아래의 Config 설정을 통해 원하는 타입의 Authorization 버튼을 활성화 할 수 있다.

 

• SwaggerConfig 설정

@Configuration
@EnableWebMvc
public class SwaggerConfig {
	@Bean
	public OpenAPI openAPI() {
		Info info = new Info()
			.title("")
			.version("")
			.description("");

		String jwtSchemeName = "bearer-key";
		SecurityRequirement securityRequirement = new SecurityRequirement().addList(jwtSchemeName);
		Components components = new Components()
			.addSecuritySchemes(jwtSchemeName, new SecurityScheme()
				.name(jwtSchemeName)
				.type(SecurityScheme.Type.HTTP)
				.scheme("bearer")
				.bearerFormat("JWT"));

		return new OpenAPI()
			.addServersItem(new Server().url("http://localhost:8080/api/v1"))
			.addServersItem(new Server().url("https://www.nogari.me/api/v1"))
			.components(components)
			.addSecurityItem(securityRequirement)
			.info(info);
	}
}

 

이제 프론트엔드에서 어떤 API든 웹 상으로 편하게 확인하고, 테스트할 수 있다.

 

 

Reference

https://happy-jjang-a.tistory.com/165