[Spring] swaggerdoc authrize 적용

경민·2024년 1월 18일

Spring

목록 보기
2/2

swaggerfox에서 적용 했던 Authrize를 sawggerdox에도 적용해보자.

import io.swagger.v3.oas.annotations.enums.SecuritySchemeIn;
import io.swagger.v3.oas.annotations.enums.SecuritySchemeType;
import io.swagger.v3.oas.annotations.security.SecurityScheme;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import io.swagger.v3.oas.models.security.SecurityRequirement;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.ArrayList;
import java.util.List;

import static com.seulha.front.common.config.SwaggerConfig.USER_TOKEN;

@SecurityScheme(
        type = SecuritySchemeType.APIKEY, in = SecuritySchemeIn.HEADER,
        name = USER_TOKEN, description = "Auth Token"
)
@Configuration
public class SwaggerConfig {

    static final String USER_TOKEN = "USER-TOKEN";

    @Bean
    public OpenAPI openApi() {
        return new OpenAPI()
                    .info(new Info()
                            .version("v0.1")
                            .title("프로젝트 이름")
                            .description("API DOC")
                    ).security(
                        securityRequirements()
                    );
    }

    private List<SecurityRequirement> securityRequirements() {
        List<SecurityRequirement> securityRequirements = new ArrayList<>();
        securityRequirements.add(new SecurityRequirement().addList(USER_TOKEN));
        return securityRequirements;
    }

}

@SecurityScheme가 버튼을 만들어준다.
HEADER에 USER_TOKEN이라는 이름으로 swagger가 넣어준다.

.security()에 넘겨주는 인자는 실제로 서버에서 받을 토큰의 이름을
SecurityRequiredment에 addList()로 넘겨주고,
List 형식으로 넣어주면 된다.

profile
안녕하세요

0개의 댓글