[JAX-RS] Codegen Creates form-data variables with duplicate names

[jencodingatwork]

Description

The JAX-RS Code generator creates variables with duplicate names when more than one file is included in the API call which results in a compilation error.

Swagger-codegen version

2.1.6

Swagger declaration file content or url

paths:
  /Plugin:
    post:
      tags:
        - Plugin
      summary: Upload Plugin
      description: This can only be done by the logged in user.
      operationId: createPlugin
      consumes:
      - "multipart/form-data"
      produces:
        - application/json
        - application/xml
      parameters:
        - in: formData
          name: json
          description: Uploaded Plugin
          required: true
          type: string
        - in: formData
          name: jarFile
          description: Jar File to upload
          required: true
          type: file
        - in: formData
          name: configFile
          description: config File to upload
          required: true
          type: file
      responses:
        200:
          description: successful operation

Command line used for generation

java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i C:/PluginAPI/plugin.yaml -l jaxrs -o C:/Temp/JAX_RStest java -jar modules/swagger-codegen-cli/target/swagger-codegen-cli.jar generate -i C:/PluginAPI/plugin.yaml -l jaxrs -o C:/Temp/JAX_RStest

Steps to reproduce

1. Execute command
2. Look at Plugin API code, where you should see the following method. Notice that there are two variables named inputStream, two variables named fileDetail, and all params are set to “file”.

@POST 
    @Produces({ "application/json", "application/xml"})
    @Consumes({"multipart/form-data"})
    @io.swagger.annotations.ApiOperation(value = "Upload Plugin", notes = "This can only be done by the logged in user.", response = void.class, tags={ "Plugin", })
    @io.swagger.annotations.ApiResponses(value = { 
        @io.swagger.annotations.ApiResponse(code = 200, message = "successful operation", response = void.class) })
    public Response createAnalytic(@ApiParam(value = "Uploaded Plugin", required=true)@FormParam("json")  String json,
            @FormDataParam("file") InputStream inputStream,
            @FormDataParam("file") FormDataContentDisposition fileDetail,
            @FormDataParam("file") InputStream inputStream,
            @FormDataParam("file") FormDataContentDisposition fileDetail,@Context SecurityContext securityContext)
    throws NotFoundException {
        return delegate.createAnalytic(json, inputStream, fileDetail, inputStream, fileDetail, securityContext);
    }

Related issues

I could not find any related issues.

Suggest a Fix

My fix to this was to modify three mustache files so that the hardcoded variable name also includes the paramName resulting in the following code:

@POST 
    @Produces({ "application/json", "application/xml"})
    @Consumes({"multipart/form-data"})
    @io.swagger.annotations.ApiOperation(value = "Upload Plugin", notes = "This can only be done by the logged in user.", response = void.class, tags={ "Plugin", })
    @io.swagger.annotations.ApiResponses(value = { 
        @io.swagger.annotations.ApiResponse(code = 200, message = "successful operation", response = void.class) })
    public Response createAnalytic(@ApiParam(value = "Uploaded Plugin", required=true)@FormParam("json")  String json,
            @FormDataParam("jarFile") InputStream jarFileinputStream,
            @FormDataParam("jarFile") FormDataContentDisposition jarFileDetail,
            @FormDataParam("configFile") InputStream configFileinputStream,
            @FormDataParam("configFile") FormDataContentDisposition configFileDetail,@Context SecurityContext securityContext)
    throws NotFoundException {
        return delegate.createAnalytic(json,jarFileinputStream, jarFileDetail,configFileinputStream, configFileDetail,securityContext);
    }

Line 79 of the api.mustache file should be modified to become:

return delegate.{{nickname}}({{#allParams}}{{#isFile}}{{paramName}}inputStream, {{paramName}}Detail{{/isFile}}{{^isFile}}{{paramName}}{{/isFile}},{{/allParams}}securityContext);

The formParams.mustache file should be updated to become:

{{#isFormParam}}{{#notFile}}@ApiParam(value = "{{{description}}}"{{#required}}, required=true{{/required}}{{#allowableValues}}, {{> allowableValues }}{{/allowableValues}}{{#defaultValue}}, defaultValue="{{{defaultValue}}}"{{/defaultValue}}){{#vendorExtensions.x-multipart}}@FormDataParam("{{paramName}}")  {{{dataType}}} {{paramName}}{{/vendorExtensions.x-multipart}}{{^vendorExtensions.x-multipart}}@FormParam("{{paramName}}")  {{{dataType}}} {{paramName}}{{/vendorExtensions.x-multipart}}{{/notFile}}{{#isFile}}
            @FormDataParam("{{paramName}}") InputStream {{paramName}}inputStream,
            @FormDataParam("{{paramName}}") FormDataContentDisposition {{paramName}}Detail{{/isFile}}{{/isFormParam}}

The serviceFormParams.mustache file should be updated to become:

{{#isFormParam}}{{#notFile}}{{{dataType}}} {{paramName}}{{/notFile}}{{#isFile}}InputStream {{paramName}}inputStream, FormDataContentDisposition {{paramName}}fileDetail{{/isFile}}{{/isFormParam}}

[wing328]

@jencodingatwork thanks for reporting the issue and suggesting a fix to address the issue.

Your suggested solution looks good to me. May I know if you've a cycle to submit a PR for your suggested fix?

[jencodingatwork]

Sure, I should be able to submit one by the end of this week.

[wing328]

@jencodingatwork thanks. Let us know if you need help submitting the PR.

[jencodingatwork]

@wing328 I have created a PR with the fix (#3304)

[wing328]

PR merged. Thanks for the contribution.

[YathendraPrasad]

@wing328 , Has the fix been merged to 2.2.2 swagger-codegen-maven-plugin . I could still see the issue . Here is my JSON and the API spec
JSON :
{
"name": "classname_positive_examples",
"in": "formData",
"description": "A compressed (.zip) file of images that depict the visual subject for a class within the classifier. Must contain a minimum of 10 images.",
"required": true,
"type": "file"
},

                {
                    "name": "negative_examples",
                    "in": "formData",
                    "description": "A compressed (.zip) file of images that do not depict the visual subject of any of the classes of the new classifier. Must contain a minimum of 10 images.",
                    "required": false,
                    "type": "file"
                }

API Generated :

@post
@path("/classifiers/{classifier_id}")
@consumes({ "multipart/form-data" })
@produces({ "application/json" })
@io.swagger.annotations.ApiOperation(
value = "Update a classifier",
notes = "",
response = GetClassifiersPerClassifierVerbose.class, tags={ "VisualRecognition", })
@io.swagger.annotations.ApiResponses(value = {
@io.swagger.annotations.ApiResponse(code = 200, message = "success", response = GetClassifiersPerClassifierVerbose.class),

    @io.swagger.annotations.ApiResponse(code = 400, message = "Invalid request", response = GetClassifiersPerClassifierVerbose.class) })
@OAuthSecurity(enabled=false)   
public Response v3ClassifiersClassifierIdPost(

@ApiParam(value = "The ID of the classifier.",required=true) @PathParam("classifier_id") String classifierId,
@FormDataParam("file") InputStream inputStream,
@FormDataParam("file") FormDataContentDisposition fileDetail,@ApiParam(value = "API Key used to authenticate.") @QueryParam("api_key") String apiKey
,
@FormDataParam("file") InputStream inputStream,
@FormDataParam("file") FormDataContentDisposition fileDetail,@ApiParam(value = "The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format.", defaultValue="2016-05-20") @DefaultValue("2016-05-20") @QueryParam("version") String version
)
throws NotFoundException, ServiceFactoryFinderException {
...

}

[YathendraPrasad]

@wing328 : same name "inputStream" created

[YathendraPrasad]

Hi ,

Any update on this will be helpful

Thanks

[jencodingatwork]

@YathendraPrasad It looks like the code change is in the JavaJaxRS resources code, but I don't know if it is in the maven plugin. In the worse case scenario, you can do what I did and write a modified version of the JavaJaxRS code generator so that it does what you need.

[YathendraPrasad]

Hey thanks @jencodingatwork for the update and sorry for late reply . After making the changes that you have pointed to i have encountered the below issues

Build Issue

[128,32] method v3DetectFacesPost in class com.ibm.mfp.adapters.sample.api.VisualRecognitionApi cannot be applied to given types;
required: java.lang.String,java.io.File,java.lang.String,java.lang.String
found: java.lang.String,java.io.InputStream,com.sun.jersey.core.header.FormDataContentDisposition,java.lang.String,java.lang.String,javax.ws.rs.core.SecurityContext
reason: actual and formal argument lists differ in length

Server Side code :

`@POST
@path("/detect_faces")
@consumes({ "multipart/form-data" })
@produces({ "application/json" })
@io.swagger.annotations.ApiOperation(
value = "Detect faces in an image",
notes = "",
response = Faces.class, tags={ "VisualRecognition" })
@io.swagger.annotations.ApiResponses(value = {
@io.swagger.annotations.ApiResponse(code = 200, message = "success", response = Faces.class),

    @io.swagger.annotations.ApiResponse(code = 400, message = "Invalid request", response = Faces.class) })
@OAuthSecurity(enabled=false)   
public Response v3DetectFacesPost(@ApiParam(value = "API Key used to authenticate.") @QueryParam("api_key") String apiKey

,

        @FormDataParam("imageFile") InputStream imageFileInputStream,
        @FormDataParam("imageFile") FormDataContentDisposition imageFileDetail ,

@ApiParam(value = "A JSON file containing an array of image URLs to analyze. For example: {"urls": ["...", "..."]}")@FormDataParam("parameters") String parameters ,@ApiParam(value = "The release date of the version of the API you want to use. Specify dates in YYYY-MM-DD format.", defaultValue="2016-05-20") @DefaultValue("2016-05-20") @QueryParam("version") String version
,@context SecurityContext securityContext)
throws NotFoundException, ServiceFactoryFinderException {

    //return getV3ApiService().v3DetectFacesPost(apiKey,inputStream, fileDetail,parameters,version,securityContext);

    com.ibm.mfp.adapters.sample.ApiClient apiAuthInstance = new com.ibm.mfp.adapters.sample.ApiClient();

    com.ibm.mfp.adapters.sample.api.VisualRecognitionApi apiInstance = new com.ibm.mfp.adapters.sample.api.VisualRecognitionApi(apiAuthInstance);
    
     String retval = "NA";
     com.ibm.mfp.adapters.sample.model.Faces result = null;
     apiAuthInstance.setUsername(configurationApi.getPropertyValue("username"));
     apiAuthInstance.setPassword(configurationApi.getPropertyValue("password"));
    try {
        System.out.println("Calling Node server.");
       // result = apiInstance.v3DetectFacesPost(apiKey,imageFile,parameters,version);
       **result = apiInstance.v3DetectFacesPost(apiKey,imageFileInputStream, imageFileDetail,parameters,version,securityContext);**
        System.out.println(result);
    } catch (Exception e) {
        System.err.println("Exception when calling V3Api#v3DetectFacesPost");
        e.printStackTrace();
    }
    System.out.println("Return from Node server: "+ result);
    if (result != null)
    {
        retval = result.toString(); 
    } 
    return Response.ok().entity(result).build();
}`

Client side generated Code :

public Faces v3DetectFacesPost(String apiKey, File imageFile, String parameters, String version) throws ApiException { ApiResponse<Faces> resp = v3DetectFacesPostWithHttpInfo(apiKey, imageFile, parameters, version); return resp.getData(); }

It would be help full if i get some quick solution . I could not figure out where exactly is the problem