Spring Fox+Swagger UIでAPI仕様書を表示した時に出る警告を消す

5554 ワード
Springfox spring-boot Kotlin gradle Kotlin テキストリンク

環境

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が上がってた
https://github.com/springfox/springfox/issues/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" )
}

これで警告も出なくてスッキリ！！！