카테고리1프로그래밍
카테고리2스프링부트
제목스프링부트 스웨거 적용하기
작성자고성훈
작성일2024-12-18 11:16:38
[스프링부트 3.2.3 기준]
1. build.gradle에 implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.2.0' 추가
2. SwaggerConfig 클래스 생성 후 아래와 같이 설정
3. localhost:8080/swagger-ui/index.html 경로로 접속
============================================================================================

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

@Configuration
public class SwaggerConfig {
@Bean
public OpenAPI openAPI() {
String jwt = "JWT";
SecurityRequirement securityRequirement = new SecurityRequirement().addList(jwt);
Components components = new Components().addSecuritySchemes(jwt, new SecurityScheme()
.name(jwt)
.type(SecurityScheme.Type.HTTP)
.scheme("bearer")
.bearerFormat("JWT")
);
return new OpenAPI()
.components(new Components())
.info(apiInfo())
.addSecurityItem(securityRequirement)
.components(components);
}
private Info apiInfo() {
return new Info()
.title("CRIZEL") // API의 제목
.description("CRIZEL") // API에 대한 설명
.version("1.0.0"); // API의 버전
}
}
============================================================================================
수정목록