Springfoxでリクエストパラメータの収集対象から除外する方法

Springfox

【前提条件】

[環境]
  • JDK 1.8.111
  • Spring Boot 1.4.2
  • Springfox 2.6.1
[参考サイト]

【概要】

Springfoxのパラメータで特定のアノテーションが付いているものだけ除外する方法です。

【困ってたこと】

Springfoxを色々とためてしていたところ
@AuthenticationPrincipalを付与したパラメータも拾ってしまってました。

public class Hoge {
    // UserInfoは自分で作った独自のクラス
    public ResponseEntity<Fuga> list(@AuthenticationPrincipal final UserInfo userInfo) {
      // 省略
    }
}

【解決方法】

DocketにignoredParameterTypesというメソッドがあるのでそれを設定に追加するだけです。

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.security.core.annotation.AuthenticationPrincipal;
import org.springframework.web.bind.annotation.RestController;

import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class ApiDocConf {

    @Bean
    public Docket apiDoc() {

        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                    .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class))
                    .build()
                .useDefaultResponseMessages(false)
                .ignoredParameterTypes(UserInfo.class); // ここ
    }
}

@AuthenticationPrincipalを指定しても同様の動きになります。
Javadocのサンプルとかには普通のクラスが書かれているので、
クラス自体を指定した方がメソッドの意図通りなのかなと思います。