Swagger UI 설정

뚜우웅이·2025년 4월 19일

캡스톤 디자인

목록 보기
13/35

Config

현재 프로젝트에 Swagger UI 설정이 누락되어 있어, API 문서화가 제대로 이루어지지 않고 있어 Config 설정을 추가해준다.

@Configuration
public class SwaggerConfig {

    @Bean
    public OpenAPI openAPI() {
        final String securitySchemeName = "bearerAuth";

        return new OpenAPI()
                .info(new Info()
                        .title("FreeMarket API")
                        .description("FreeMarket 프로젝트 API 문서")
                        .version("v1.0.0")
                        .contact(new Contact()
                                .name("FreeMarket")
                                .email("rlaxogjs202014030@gmail.com")
                                .url("http://localhost:8080")) // 이후 수정
//                        .license(new License()
//                                .name("Apache 2.0")
//                                .url("http://www.apache.org/licenses/LICENSE-2.0.html")))
                )
                .addSecurityItem(new SecurityRequirement().addList(securitySchemeName)) // JWT 인증 버튼 추가
                .components(new Components()
                        .addSecuritySchemes(securitySchemeName, new SecurityScheme()
                                .name(securitySchemeName)
                                .type(SecurityScheme.Type.HTTP)
                                .scheme("bearer")
                                .bearerFormat("JWT")));
    }
}

Swagger API 문서의 설명을 추가하고 JWT 인증 기능을 지원하도록 설정하였다.


profile
공부하는 초보 개발자

0개의 댓글