OpenAPITools / OpenAPITools/openapi-generator

[BUG][JAVA][Spring] Form passing with application/x-www-form-urlencoded uses @RequestPart instead of @RequestParam

Open
#7,794 1 comment 15 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Issue: Bug
Dominant language
Java
Stars
26.8k
Forks
7.7k
PR merge metrics
PR metrics pending

Description

Bug Report Checklist
  • Have you provided a full/minimal spec to reproduce the issue?
  • Have you validated the input using an OpenAPI validator (example)?
  • Have you tested with the latest master to confirm the issue still exists?
  • Have you searched for related issues/PRs?
  • What's the actual output vs expected output?
  • [Optional] Sponsorship to speed up the bug fix or feature request (example)
Description

Using application/x-www-form-urlencoded as the requestbody generates spring methods with @RequestParts instead of @RequestParam

More info:
https://github.com/swagger-api/swagger-codegen/issues/6438

openapi-generator version

5.0.0-beta2

OpenAPI declaration file content or url
openapi: 3.0.1
info:
  title: 'app'
  version: 0.0.1
servers:
  - url: http://localhost:8080/api
    description: Development server
paths:
  /authorize:
    post:
      summary: Authorization Endpoint
      operationId: authorize
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                grant_type:
                  type: string
Generation Details

I'm generating the server code with openapi-generator-maven-plugin .

Suggest a fix

Use @RequestParam for application/x-www-form-urlencoded instead of @RequestPart since it's not a file

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

Start by reproducing the generated Spring server with the supplied OpenAPI declaration and the openapi-generator-maven-plugin. Trace how the application/x-www-form-urlencoded request body is mapped to method parameters. Done means generated form fields use @RequestParam rather than @RequestPart, without changing file-upload handling.

Written by the indexing model from the issue text.

Assessment

Tech stack
java, spring
Domain
api, backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.