add multipart form upload file, swagger generate json error

[wangzilong]

Hi all:
I use this example https://github.com/swagger-api/swagger-core/tree/v1.3.12/samples/java-jersey2-guice,
add this method in PetResource.java:

    @POST
    @Path("/{petId}/uploadImage")
    @Consumes({MediaType.MULTIPART_FORM_DATA})
    @Produces({MediaType.APPLICATION_JSON})
    @ApiOperation(value = "uploads an image")
    public Response uploadFile(
            @ApiParam(value = "ID of pet to update", required = true) @PathParam("petId") Long petId,
            @ApiParam(value = "Additional data to pass to server") @FormDataParam("additionalMetadata") String testString,
            @ApiParam(value = "file to upload") @FormDataParam("file") InputStream inputStream,
            @ApiParam(value = "file detail") @FormDataParam("file") FormDataContentDisposition fileDetail) {
        return Response.status(200).entity("true").build();
    }

but the scanner generate json is :

...
{
    "path": "/pet/{petId}/uploadImage",
    "operations": [
        {
            "method": "POST",
            "summary": "uploads an image",
            "notes": "",
            "type": "void",
            "nickname": "uploadFile",
            "produces": [
                "application/json"
            ],
            "consumes": [
                "multipart/form-data"
            ],
            "parameters": [
                {
                    "name": "petId",
                    "description": "ID of pet to update",
                    "required": true,
                    "type": "integer",
                    "format": "int64",
                    "paramType": "path",
                    "allowMultiple": false
                },
                {
                    "name": "body",
                    "description": "file detail",
                    "required": false,
                    "type": "FormDataContentDisposition",
                    "paramType": "body",
                    "allowMultiple": false
                }
            ]
        }
    ]
}
...

some thing not work, and miss some parameters.
please help me.

[webron]

Any reason you're using 1.3.12?

[wangzilong]

Yes, I am using com.wordnik:swagger-jersey2-jaxrs_2.10:1.3.12

[webron]

Yes, but why do you use that version and not the latest?

[wangzilong]

I'm sorry. I will try the latest right now.

[webron]

Thanks, please keep us posted.

[wangzilong]

I can not find the example of swagger-jersey2-guice in the latest version, can you give it to me. Thank you

[webron]

Samples have migrated - https://github.com/swagger-api/swagger-samples/tree/master/java/java-jersey2-guice

[wangzilong]

I have try this project last week.
When I add the same method in PetResource.java.
it will return JSON is :

...
{
    "post": {
        "tags": [
            "pet"
        ],
        "summary": "uploads an image",
        "description": "",
        "operationId": "uploadFile",
        "consumes": [
            "multipart/form-data"
        ],
        "produces": [
            "application/json"
        ],
        "parameters": [
            {
                "name": "petId",
                "in": "path",
                "description": "ID of pet to update",
                "required": true,
                "type": "integer",
                "format": "int64"
            },
            {
                "in": "body",
                "name": "body",
                "description": "Additional data to pass to server",
                "required": false,
                "schema": {
                    "type": "string"
                }
            },
            {
                "name": "file",
                "in": "formData",
                "description": "file to upload",
                "required": false,
                "type": "file"
            },
            {
                "in": "body",
                "name": "body",
                "description": "file detail",
                "required": false,
                "schema": {
                    "$ref": "#/definitions/FormDataContentDisposition"
                }
            }
        ],
        ...

But the FormDataContentDisposition be generated in JSON.
Can you teach me how to deal with it?

[webron]

Did you update to the latest version?

[wangzilong]

Yes, I download this example project, then add those code and run it.

[webron]

The samples are not updated with the latest version. Make sure to update the dependency version, as there was a related bug that was solved in a recent version.

[wangzilong]

OK, thanks

[wangzilong]

Hi webron:
it does not work, the FormDataContentDisposition still in JSON.
I only add register(MultiPartFeature.class). in Application.java
Need I add other configuration？

[webron]

You're using Jersey 2, right?

[wangzilong]

Yes， Jersey's version is 2.21