1

Spring MVC REST API に springfox-swagger2 を使用しています。すべてがswaggerでうまく機能しますが、私の問題は、swaggerのドキュメントに追加情報を追加できないことです.

Maven の依存関係:

<!-- Swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.2.2</version>
</dependency>

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.2.2</version>
</dependency>

私のSwagger構成クラス:

@Configuration
@EnableWebMvc
@EnableSwagger2
@ComponentScan("path.to.controller.package")
public class SwaggerConfig {

    @Bean
    public Docket customImplementation() {
        return new Docket(DocumentationType.SPRING_WEB).apiInfo(apiInfo());
    }

    @Bean
    public UiConfiguration uiConfig() {

        return UiConfiguration.DEFAULT;
    }

    private ApiInfo apiInfo() {
        ApiInfo apiInfo = new ApiInfo("Service API", "Simple REST Service", "0.0.1",
                "mail@mail.com", "mail@mail.com", " ", " ");
        return apiInfo;
    }
}

私のコントローラークラス:

@RestController
@RequestMapping("/persons")
public class PersonController {

    Logger LOGGER = LoggerFactory.getLogger(PersonController.class);

    @RequestMapping(value = "/{id}", method = RequestMethod.GET, headers = "Accept=application/json")
    @ApiOperation(value = "doStuff", response = Person.class)
    @ApiImplicitParams({@ApiImplicitParam(name="Authorization", value="MY DESCRIPTION")})
    public @ResponseBody Person getPerson(@PathVariable String id,
          @RequestHeader(value = "Authorization") String authToken) throws Exception {

          //do things and return
    }
}

したがって、swagger-ui を呼び出すと、コントローラー、メソッド、および で定義された追加情報を除くすべてが表示され@ApiOperationます@ApiImplicitParams。問題がどこから来るのか、誰にも考えがありますか? パラメータは、swagger から作成された JSON ファイルにもありません。

4

1 に答える 1

3

customImplementation()メソッドを次のように置き換えてみてください。

@Bean
public Docket customImplementation() {
    return new Docket(DocumentationType.SWAGGER_2)
        .select()
        .apis(RequestHandlerSelectors.any())
        .build()
        .apiInfo(apiInfo());
}

プロジェクトをビルドすると、追加情報が表示されます。

編集:違いがあるかどうかはわかりませんが、これらの依存関係を使用しています:

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.3.1</version>
    </dependency>

    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.1.2</version>
    </dependency>
于 2016-02-19T12:34:00.437 に答える