KEEM

  • 홈
  • 블로그
  • 갤러리
  • 프로필
© Powered by 6-keem
2024-10-18
Backend

AWS 스프링부트, Swagger-ui 연동

AWS EC2 환경 구성 (3)
AWS 스프링부트, Swagger-ui 연동

이전 포스트
AWS SpringBoot, MariaDB 연결하기
다음 포스트
Jenkins로 CI/CD 구축하기 (2)

환경구성

Series bookmark
  1. AWS 스프링부트, Swagger-ui 연동
  2. AWS SpringBoot, MariaDB 연결하기
  3. AWS EC2 docker, docker-compose 설치
  4. AWS EC2 생성 및 접속
3e6c823bfaa3334d.png
해당 글은 기록용으로 부족한 부분이 있을 수 있습니다. 참고 부탁드립니다.

1. build.gradle 의존성 추가

dependencies {
    implementation 'org.springdoc:springdoc-openapi-starter-webmvc-ui:2.0.4'
}

2. application.yml 파일 수정

하단에 해당 부분을 추가하여준다.

springdoc:
  swagger-ui:
    groups-order: DESC
    tags-sorter: alpha
    operations-sorter: method
    disable-swagger-default-url: true
    display-request-duration: true
    defaultModelsExpandDepth: 2
    defaultModelExpandDepth: 2
    path: /swagger-ui/index.html
  api-docs:
    path: /api-docs
  show-actuator: true
  default-consumes-media-type: application/json
  default-produces-media-type: application/json
  writer-with-default-pretty-printer: true
  model-and-view-allowed: true
  paths-to-match:
    - /api/v1/**

3. SwaggerConfig 클래스 생성

import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.info.Info;
import org.springdoc.core.models.GroupedOpenApi;
import org.springframework.






















접속 성공접속 성공

context
.
annotation
.
Bean
;
import org.springframework.context.annotation.Configuration;
@Configuration
public class SwaggerConfig {
@Bean
public GroupedOpenApi publicApi() {
return GroupedOpenApi.builder()
.group("springdoc-public")
.pathsToMatch("/**")
.build();
}
@Bean
public OpenAPI openAPI() {
Info info = new Info()
.version("v1.0")
.title("TEST")
.description("Swagger-ui 테스트입니다.");
return new OpenAPI()
.info(info);
}
}