OpenAPITools / OpenAPITools/openapi-generator

[REQ] [sprind-cloud] Provide multiple response bodies

Open
#8,701 1 comment 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Enhancement: Feature
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Is your feature request related to a problem? Please describe.

There should be support for several response bodies. The challenge will be that spring needs several methods for different media types.

Describe the solution you'd like

Example with different response bodies

  /foo:
    post:
      operationId: createFoo
      ...
      responses:
        '200':
          description: "Return"
          content:
                    application/octet-stream:
                      schema:
                        type: string
                        format:binary
                    text/plain:
                      schema:
                        type: string
                    application/json:
                      schema:
                         ref: "#/components/schemas/FooDto"

The generated code should contain 3 methods

@RequestMapping(produces = "application/octet-stream")
public ResponseEntity<Resource> createFoo1(...) {...}

@RequestMapping(produces = "text/plain")
public ResponseEntity<String> createFoo2(...) {...}

@RequestMapping(produces = "application/json")
public ResponseEntity<FooDto> createFoo3(...) {...}

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue provides an OpenAPI response example with three media types and the expected Java/Spring methods; no file or test is named. Start by tracing the Spring server generator's response handling, then add coverage that verifies distinct generated methods for the three response bodies.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, openapi, spring
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.