[Spring]: RequestBody required-handling

Open
  • Is something wrong?
#1,432 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
62/100
Issue type
Bug
Clarity
Clearly specified
Activity status
Active
Tech stack
java, openapi, spring
Domain
backend-api-design

Research direction

The bug is that the spring generator ignores requestBody.required: false and always emits @RequestBody with its default required=true. Start in the Spring server templates and find where the @RequestBody annotation is written for request bodies. Make it pass required from the spec, then check that a POST to /search with no body and no query parameter is accepted. Done when the generated controller compiles and both curl cases from the issue succeed.

Written by the indexing model from the issue text.

Description

Bug

Description

My goal is to have an endpoint to enable a quick search and an extended search. Using the quick search the endpoint only needs a query-param. Using the extended search a full search-body is required.

I was defining my openapi as follows:

/search:
    post:
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/SearchCriterion"
      parameters:
        - in: query
          name: value
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/SearchResult"

I was expecting to be able to send curl requests like:

  • curl -X POST
    'http://localhost/search'
    -H 'Content-Type: application/json'
    -d '[{"type":"NAME","value":"Dummy"}]'
  • curl -i -X POST
    'http://localhost/search?value=something'
    -H 'Content-Type: application/json'

But only the first request returned any data. The second request only resulted in a 404.

After shortly analysing the problem I found that the required-property is not handed to the @RequestBody Spring annotation. As the annotation uses true as default for the required attribute, I need to hand the body for every request.

This behaviour should be altered to correctly pass the required-property to the code.

Version

We are using [email protected] (which uses [email protected]) but the current main is also not passing the required-property.

Language / Generator Affected

  • spring (i haven't checked any other generators as this should be specific for this generator)

OpenAPI/Swagger Spec

/search:
    post:
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: "#/components/schemas/SearchCriterion"
      parameters:
        - in: query
          name: value
          required: false
          schema:
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: "#/components/schemas/SearchResult"

Environment

OS: Windows 11

Java Version: temurin-21.0.6+7.0.LTS

Build Tool: Maven

swagger-codegen-generators Version: 1.0.54

Checklist

  • [/] I have searched the existing issues to avoid duplicates.
  • [/] I have included a minimal reproducible spec or configuration.
  • [/] I have clearly described the steps to reproduce the issue.
  • [/] I have specified which generator or template is affected.
Dominant language
Mustache
Stars
299
Forks
439
No merged PRs in 30d

Getting set up

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.

More from swagger-api/swagger-codegen-generators

All issues in swagger-api/swagger-codegen-generators

Similar issues

More Backend & API Design issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.