Swagger Springboot 3.x JWT 인증 적용 방법

Swagger Springboot 3.x JWT 인증 적용 방법입니다.

 

Swagger 다양한 설정 방법은 아래의 Link를 확인하세요!

 

Link : https://aljjabaegi.tistory.com/713

Swagger Springboot 3.x 의존성 주입 및 Information 설정, 기본 설정

 

Link : https://aljjabaegi.tistory.com/714

Swagger Springboot 3.x Operation 설정 방법

 

Link : https://aljjabaegi.tistory.com/715

Swagger Springboot 3.x Response 설정 방법

 

Link : https://aljjabaegi.tistory.com/716

Swagger Springboot 3.x Spring.properties 설정 옵션

 

Link : https://aljjabaegi.tistory.com/718

Swagger Springboot 3.x Grouping 방법

인증 관련

JWT (Bearer Token 방식)

SwaggerConfig 에 @SecurityScheme 를 추가합니다.

@SecurityScheme(
        name = "JWT Token",
        type = SecuritySchemeType.HTTP,
        bearerFormat = "JWT",
        scheme = "bearer"
)

 

그럼 위와 같이 Authorize 버튼이 추가되게 됩니다.

버튼을 클릭하면 아래와 같이 Token 정보를 입력할 수 있는 팝업창이 표출됩니다.

 

값을 입력하고 Authorize 버튼을 클릭하면 인증이 필요한 Operation 요청 시 Header에 Authorization 정보가 추가되게 됩니다. 인증이 필요한 Operation 에는 @SecurityRequirement 를 추가합니다.

@RestController
@Tag(name = "[API-001] 멤버 정보 조회, 편집", description = "[담당자 : GEONLEE]")
@SecurityRequirement(name = "JWT Token")
public class MemberController {

 

@SecurityRequirement를 추가하면 오퍼레이션에 자물쇠 이미지가 추가되고 

 

특정 Operation 에만 추가하고 싶다면 @Operation의 security 에 추가해도 되고 @Operation과 같은 레벨에 @SecurityRequirement를 추가해도 됩니다.

 

Github Swagger Project

https://github.com/aljjabaegiProgrammer/swagger-api

GitHub - aljjabaegiProgrammer/swagger-api: swagger API project