환경

Spring Boot 2.2.3.RELEASE - 2.2.4.RELEASE
Spring Fox 2.9.2
Kotlin 1.3.61
Gradle

환경은 다음 기사의 만다

상황

이런 식으로 Controller에 swagger의 어노테이션을 바르게 붙여 API 사양서에 필요한 코멘트를 힘들게 써 간다

WarningSampleController.kt

package com.example.spring.boot.web.controller.spring.fox.example

import io.swagger.annotations.*
import org.springframework.web.bind.annotation.GetMapping
import org.springframework.web.bind.annotation.PathVariable
import org.springframework.web.bind.annotation.RestController

@Api(
        tags = ["API仕様書表示時の警告確認用API"] ,
        description = "デフォのままだと警告が出る／対応の確認用API"
)
@RestController
class WarningSampleController {

    @ApiOperation(
            value = "サンプル文字列取得API" ,
            notes = "パスパラメータから文字列を受け取ってそれを出力するサンプルAPI"
    )
    @ApiResponses(
            ApiResponse( code = 200 , message = "サンプル文字列" , response = String::class )
    )
    @GetMapping( "/warning-sample/{param}")
    fun getSample(
            @ApiParam( value = "パスパラメータから受け取る数値" , required = true )
            @PathVariable( "param" )
            param : Int
    ) = "Hello Sample$param"

}

출력된 페이지도 좋은 느낌

문제점

페이지를 여는 단계에서 오류가 발생합니다.

분명히 URL의 문자열을 Int로 변환 할 수없는 모습

해결책

Spring Fox의 GitHub에도 Issue가 올랐다.
htps : // 기주 b. 코m/sp린g후x/sp린g후x/이스에 s/2265

Spring Fox가 의존하는 라이브러리의 문제처럼 보입니다.

그래서 Gradle에서 Spring Fox 라이브러리를 넣을 때,
마음대로 들어오는 종속 라이브러리를 제거하고 다른 버전 추가

build.gradle.kt

dependencies {
    implementation("io.springfox:springfox-swagger2:2.9.2") {
        exclude(module = "swagger-annotations")
        exclude(module = "swagger-models")
    }
    implementation("io.swagger:swagger-annotations:1.5.21")
    implementation("io.swagger:swagger-models:1.5.21")
    implementation( "io.springfox:springfox-swagger-ui:2.9.2" )
}

이것으로 경고도 나오지 않아 깨끗이! ! !