Spring에서 Swagger 사용하기 - 작성중

Spring 프레임워크 환경에서 Swagger를 통해 apidoc을 작성할 때 참고하기 위한 기록

작성일자
1. 2024-01-03(수)

        // build.gralde.kts에 작성
        implementation("org.springdoc:springdoc-openapi-ui:버전")
        implementation("org.springdoc:springdoc-openapi-kotlin:버전")
        implementation("org.springdoc:springdoc-openapi-security:버전")

Schema Annotation

• 웬만한 설명은 대부분 @Schema를 통해 처리가 가능하다
• 사용방법 및 설명

// 1. GET 요청 DTO
@Schema(name="A클래스 정보 요청", description="A클래스에 대한 설명")
class GetA(
  @field:Min(value = 1)
  @field:Max(value = 100)
  @field:Schema(
    description = "b에 대한 설명", 
    // minimum = 1, // 최소 값 지정, Min 어노테이션 값을 사용
    // maximum = 100, // 최대 값 지정, Max 어노테이션 값을 사용
  )
  val b: Long,
  
  // implementation을 통해 Enum을 지정하게 되면 이 속성이 해당 Enum 값을 사용한다고 알려줘 Swagger 페이지에서 값을 셀렉트 박스로 표출함
  @field:Schema(description = "c에 대한 설명", implementation = EnumC::class)
  val c: EnumC,
)