[BUG][SPRING]compilation errors due to different request body type in api and apiDelegate files

[anuhyapolisetti]

Bug Report Checklist

• [x] Have you provided a full/minimal spec to reproduce the issue?
• [ ] Have you validated the input using an OpenAPI validator (example)?
• [x] What's the version of OpenAPI Generator used?
• [x] Have you search for related issues/PRs?
• [x] What's the actual output vs expected output?
• [ ] [Optional] Bounty to sponsor the fix (example)

Description

We have encountered this problem generated Api and ApiDelegate files have different request body types (Resource/MultipartFile), which is resulting in compilation errors.

Issue seemed to have addressed in v4.0.0-beta3 version, but issue still persists when we tried with the cli version of v4.0.0-beta3.

openapi-generator version

v4.0.2

OpenAPI declaration file content or url

openapi: 3.0.1
info:
  title: testapp
  version: 0.0.1
servers:
  - url: 'http://localhost:8081/api'
    description: Development server
paths:
  '/foo':
    post:
      operationId: foo
      requestBody:
        content:
          image/png:
            schema:
              type: string
              format: binary
      responses:
        default:
          description: successful operation

Command line used for generation

java -jar openapi-generator-cli.jar generate -g spring -i api.yml -o ./out --additional-properties delegatePattern=true

Steps to reproduce

1. Run the command above with provided api.yml.

2. Open out/src/main/java/org/openapitools/api/FooApi.java, look at generated foo method

   default ResponseEntity<Void> foo(@ApiParam(value = ""  )  @Valid @RequestBody Resource body) {
       return getDelegate().foo(body);
   }

3. Open out/src/main/java/org/openapitools/api/FooApiDelegate.java, look at generated apiDelegate method

   default ResponseEntity<Void> foo(MultipartFile body) {
       return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
   }

   foo from FooApiDelegate consumes MultipartFile whereas FooApi passes Resource as request body type.

Related issues/PRs

1. https://github.com/OpenAPITools/openapi-generator/pull/2271

Issue seemed to have addressed in v4.0.0-beta3 version per above PR, but issue still persists when we tried with the cli version of v4.0.0-beta3.

2. https://github.com/OpenAPITools/openapi-generator/issues/2191

Suggest a fix

Use either Multipartfile or Resource in both api and apidelegate

[auto-labeler[bot]]

👍 Thanks for opening this issue! 🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[nickshoe]

I'm experiencing the same problem with version 4.1.3 (in a JHipster API-first project).

operation:

/attachments:
  post:
    description: Creates a new Attachment by a file upload
    operationId: createAttachment
    requestBody:
      content:
        application/octet-stream:
          schema:
            $ref: '#/components/schemas/AttachmentFile'

schema:

AttachmentFile:
  type: string
  format: binary

generated "...ApiDelegate" interface method:

default ResponseEntity<Attachment> createAttachment(MultipartFile body) { ... }

generated "...Api" interface method:

default ResponseEntity<Attachment> createAttachment(@ApiParam(value = ""  )  @Valid @RequestBody Resource body) {
    return getDelegate().createAttachment(body);
}

[saephir]

I'm dropping this workaround just in case:

Define typeMapping in pom.xml (or analogous Gradle config):

<typeMappings>binary-string=org.springframework.core.io.Resource</typeMappings>

and use binary-string in the OpenAPI specification:

requestBody:
  content:
    application/octet-stream:
      schema:
        type: binary-string

[d-j-kendall]

<typeMappings>binary-string=org.springframework.core.io.Resource</typeMappings>

Life saver my guy, I've been looking all over for a workaround as this issue is still present in 5.4.0