[Spring] Required post body with path parameters produces uncompilable code #255

staale · 2018-12-07T13:49:01Z

If you have a required requestBody in combination with path parameters, the body will be placed first, and there will be no comma after it in the generated codes argument list:

Attached sample openapi.yaml, invoke with:

java -jar swagger-codegen-cli-3.0.3.jar generate -i openapi.yaml -l spring -o test

Resulting code:

    ResponseEntity<Body> failure(
        @ApiParam(value = "" ,required=true )  @Valid @RequestBody
        Body body@ApiParam(value = "First value",required=true) @PathVariable("first") 
        String first,
        @ApiParam(value = "Second value",required=true) @PathVariable("second") String second);

I have reformatted the code slightly to highlight the error.

openapi.txt

The text was updated successfully, but these errors were encountered:

totothekiller · 2018-12-20T15:46:04Z

I have the same issue (with swagger-codegen-maven-plugin 3.0.3)
In my case, the type of @RequestBody body variable is wrongly set to Object.

wvitte · 2019-01-03T06:25:24Z

I had similar issue with swagger-codegen-maven-plugin 3.0.3. I see the no comma after it generated code.

default ResponseEntity<IndexRequestResponse> createIndex( IndexRequest body String id) {

voydz · 2019-01-09T07:19:49Z

Hi,

Maybe this issue has to be generalized? I am experiencing the same issue for both csharp generators (csharp and csharp-dotnet2).

Example:

Request method definition:

...
"/api/v1/Device/AddUserDevice":{
   "post":{
      "tags":[
         "Device"
      ],
      "operationId":"Device_AddUserDevice",
      "consumes":[
         "application/json",
         "text/json",
         "application/xml",
         "text/xml",
         "application/x-www-form-urlencoded"
      ],
      "produces":[
         "application/json",
         "text/json",
         "application/xml",
         "text/xml"
      ],
      "parameters":[
         {
            "name":"value",
            "in":"body",
            "required":true,
            "schema":{
               "$ref":"#/definitions/DeviceModel"
            }
         }
      ],
      "responses":{
         "200":{
            "description":"OK"
         },
         "400":{
            "description":"BadRequest"
         }
      }
   }
}
...

Body schema definition:

...
"DeviceModel":{
   "type":"object",
   "properties":{
      "id":{
         "type":"string"
      },
      "created":{
         "format":"date-time",
         "type":"string"
      },
      "additionalInformation":{
         "type":"string"
      },
      "deviceId":{
         "type":"string"
      },
      "deviceTypeId":{
         "format":"int32",
         "type":"integer"
      },
      "userId":{
         "type":"string"
      },
      "deviceName":{
         "type":"string"
      },
      "controlAuthorizationLevel":{
         "format":"int32",
         "type":"integer"
      },
      "isOwnedByMe":{
         "type":"boolean"
      },
      "isSharedToOthers":{
         "type":"boolean"
      }
   }
}
...

And the output I get for <SwaggerGeneratedProjectRoot>/Api/DeviceApi.cs is:

    /// <summary>
    /// Represents a collection of functions to interact with the API endpoints
    /// </summary>
    public interface IDeviceApi : IApiAccessor
    {
        #region Synchronous Operations
        /// <summary>
        /// 
        /// </summary>
        /// <remarks>
        /// 
        /// </remarks>
        /// <exception cref="Api.Client.ApiException">Thrown when fails to make API call</exception>
        /// <param name="body"></param>
        /// <param name="id"> (optional)</param>
        /// <param name="created"> (optional)</param>
        /// <param name="additionalInformation"> (optional)</param>
        /// <param name="deviceId"> (optional)</param>
        /// <param name="deviceTypeId"> (optional)</param>
        /// <param name="userId"> (optional)</param>
        /// <param name="deviceName"> (optional)</param>
        /// <param name="controlAuthorizationLevel"> (optional)</param>
        /// <param name="isOwnedByMe"> (optional)</param>
        /// <param name="isSharedToOthers"> (optional)</param>
        /// <returns></returns>
        void DeviceAddUserDevice (DeviceModel bodystring id = null, DateTime? created = null, string additionalInformation = null, string deviceId = null, int? deviceTypeId = null, string userId = null, string deviceName = null, int? controlAuthorizationLevel = null, bool? isOwnedByMe = null, bool? isSharedToOthers = null);
...

Notice the missing comma between the first and second parameter. DeviceModel bodystring id = null would have to be DeviceModel body, string id = null.

wvitte · 2019-01-09T07:48:20Z

it works for me if I remove

"required":true,

HugoMario · 2019-01-12T22:17:25Z

hello guys, this issue has been fixed with PR #267. Going to close this ticket but please let me know if there's still something wrong and i'll handle it.

HugoMario closed this as completed Jan 12, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Spring] Required post body with path parameters produces uncompilable code #255

[Spring] Required post body with path parameters produces uncompilable code #255

staale commented Dec 7, 2018

totothekiller commented Dec 20, 2018

wvitte commented Jan 3, 2019 •

edited

Loading

voydz commented Jan 9, 2019 •

edited

Loading

wvitte commented Jan 9, 2019 •

edited

Loading

HugoMario commented Jan 12, 2019

[Spring] Required post body with path parameters produces uncompilable code #255

[Spring] Required post body with path parameters produces uncompilable code #255

Comments

staale commented Dec 7, 2018

totothekiller commented Dec 20, 2018

wvitte commented Jan 3, 2019 • edited Loading

voydz commented Jan 9, 2019 • edited Loading

wvitte commented Jan 9, 2019 • edited Loading

HugoMario commented Jan 12, 2019

wvitte commented Jan 3, 2019 •

edited

Loading

voydz commented Jan 9, 2019 •

edited

Loading

wvitte commented Jan 9, 2019 •

edited

Loading