org.apache.cxf.jaxrs.ext.multipart.Attachmentを処理するスワッガー注釈

Question

私はファイルを受け取り、ビジネスに固有の操作を実行するREST APIを開発するプロセスです。Apacheを使用しているので、cxf 3.1.0 JAXRS注入、エンドポイントは自動的に複合型アタッチメントである今、私たちが闊歩出力を使用して、このAPIを公開する必要があるとして、それが表示される添付ファイルの代わりのInputStream

public Response sampleAPI(
      @ApiParam(value = "File to be uploaded.", required = true) 
      @Multipart(value = "file", required = true) Attachment file){ 
     // Some Logic 
    } 

をとります。

ようにファイルを送信する必要があるすべての消費者は、彼が私たちのために問題があるエンドポイントに自分のファイルを送信するためにCXF APIを使用するために必要な印象を受けます。

スガッガ注釈には何らかの方法がありますか、またはAPIのコンシューマが混乱しないように標準のinputstreamにAPIの引数として添付ファイルを変更できます。

Answer 1

ここで@ApiImplicitParam注釈を使用できます。
だから、あなたの質問に記載されたコードスニペットのために、次のように私はそれはあなたのために現在表示されているようように闊歩は、それを表示しませんhiddenとしてAttachmentメソッドの引数をマークしている

@ApiImplicitParams({ 
     @ApiImplicitParam(name = "file", value = "File to be uploaded.", required = true, dataType = "file", paramType = "form") 
    }) 
    public Response sampleAPI(
     @ApiParam(hidden = true) @Multipart(value = "file", required = true) Attachment file){ 
    // Some Logic 
    } 

注意を動作するはずです。