Spring Foxで作ったAPI仕様書にコンテキストパスつけたかったけどついてた

リファレンスにあったからやってみたけどやり方違ったって話

環境

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

環境は以下の記事のまんま

pathMapping使えばええやんって思ってた

コンテキストパスはapplication.propertiesで指定してるんですよ

application.properties

server.servlet.context-path=/test

@Valueで拾ってきたプロパティをpathMappingに入れればOK

SwaggerConfig.kt

@Configuration
@EnableSwagger2
class SwaggerConfig {

    @Value("\${server.servlet.context-path:/}")
    private val contextPath : String? = null

    @Bean
    fun configurateApiDocument(): Docket = Docket(DocumentationType.SWAGGER_2)
            .select()
            .apis(RequestHandlerSelectors.any())
            .paths(PathSelectors.any())
            .build()
            .pathMapping(contextPath)
            .
            .
            .

application.propertiesからパラメータをとってくるときは@ConfigurationPropertiesを使ったほうがいいっぽいけど、
パラメータ1つしかとってこないから@Valueでも問題ないかと

pathMappingにnullが入ってくるとまずいから、@Valueのデフォルト値に/を指定しとく

いいね

... と思っていたんだけどダメっぽい

誤解していたところ

server.servlet.context-pathの記載があれば、
実は特に何も設定しなくてもコンテキストパスの反映はやってくれてる

よく見るとちゃんとBaseUrlにはコンテキストパスがついてる

テスト用のURLが、それぞれのAPIにもコンテキストパスをつけたせいで2つかぶったURLになっちゃってる

っていうこともできるよってくらいにしといたほうがいいかも

pathMappingは何に使うんだろう・・・