Spring Pageableインターフェイスのスワッガードキュメント

Question

私はSpring Bootを使用してマイクロサービスを開発しました。 REST APIのドキュメントはSwaggerで作成されています。いくつかのRESTリソースは、Springの概念を利用してページングを自由に提供します。以下は例です：私が闊歩ページを開くと

@RequestMapping(value = "/buckets", method = GET) 
public PagedResources list(Pageable pageable, PagedResourcesAssembler assembler) { 
    return bucketService.listBuckets(pageable, assembler); 
} 

、以下のフォームは、リソースのために提供されています：

私が持っている問題は、ページング可能なパラメータは、コンテンツで検出されたということです型アプリケーション/ jsonと私はどのようにページサイズを変更する値を渡すか分からない。すべての値は無視されるようです。

クエリパラメータをJSONオブジェクトとして渡すことはできますか？またはPageableインタフェースに含まれるgetter用の独立したクエリパラメータフィールドを生成するようにSwaggerを構成することは可能ですか？

私はGradleのでSpringfoxを使用していますのでご注意ください。

compile 'io.springfox:springfox-spring-web:2.3.1' 
compile 'io.springfox:springfox-swagger2:2.3.1' 
compile 'io.springfox:springfox-swagger-ui:2.3.1' 

Answer 1

これは春フォックスの既知の問題です。問題#755を参照してください。この時点でzdilaのコメント2に基づいて、@ApiImplicitParamsを追加することは理想的ではありませんが、動作します。 @ApiImplicitParamsと

@ApiImplicitParams({ 
    @ApiImplicitParam(name = "page", dataType = "integer", paramType = "query", 
      value = "Results page you want to retrieve (0..N)"), 
    @ApiImplicitParam(name = "size", dataType = "integer", paramType = "query", 
      value = "Number of records per page."), 
    @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query", 
      value = "Sorting criteria in the format: property(,asc|desc). " + 
        "Default sort order is ascending. " + 
        "Multiple sort criteria are supported.") 
}) 

[

1https://github.com/springfox/springfox/issues/755

2https://github.com/springfox/springfox/issues/755#issuecomment-135059871

Answer 2

Vineet Bhatia氏の答えは正常に見えます。しかし、私は状況に直面しました。いつ@ApiIgnorと@ApiParam(hidden = true)が動作せず、asemblerとpageableのパラメータを見ることができます。次の行を追加してこの問題を解決しましたSwaggerConfigのDocket Beanに次の行を追加してこの問題を解決しました。

Answer 3

Vineetの回答ローカルホストで実行していない場合、Bhatiaの検証に問題があります。整数パラメータについては、jsonスキーマに対応していないと主張します。

だから私は、整数を文字列に変更：

@ApiImplicitParams({ 
     @ApiImplicitParam(name = "page", dataType = "string", paramType = "query", 
       value = "Results page you want to retrieve (0..N)"), 
     @ApiImplicitParam(name = "size", dataType = "string", paramType = "query", 
       value = "Number of records per page."), 
     @ApiImplicitParam(name = "sort", allowMultiple = true, dataType = "string", paramType = "query", 
       value = "Sorting criteria in the format: property(,asc|desc). " + 
         "Default sort order is ascending. " + 
         "Multiple sort criteria are supported.") 
})