OpenAPITools / OpenAPITools/openapi-generator
[BUG] go-server doesn't generate the same name of query param from the client
Nobody has claimed this yet.
- 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)?
- What's the version of OpenAPI Generator used?
- Have you search for related issues/PRs?
- What's the actual output vs expected output?
- [Optional] Bounty to sponsor the fix (example)
Description
parameters:
- description: 'pet id'
in: query
name: pet_id
required: true
schema:
format: int64
type: integer
style: form
When I defined query name with snake_case style, go-server generator generated code like this.
// api_default.go
// GetPet -
func (c *DefaultApiController) GetPet(w http.ResponseWriter, r *http.Request) {
query := r.URL.Query()
petId, err := parseIntParameter(query.Get("petId"))
But, from the same definition, go generator generates code like this.
// api_default.go
func (a *DefaultApiService) GetPet(ctx _context.Context, petId int64) (*_nethttp.Response, error) {
:
:
localVarQueryParams.Add("pet_id", parameterToString(petId, ""))
I want the server and the client to use the same name of query parameter "pet_id".
openapi-generator version
4.3.1-SNAPSHOT
OpenAPI declaration file content or url
openapi: 3.0.0
info:
description: 'OpenAPI Petstore'
title: OpenAPI Petstore
version: 1.0.0
servers:
- description: The local server
url: https://localhost:8080/{version}
paths:
/pets:
get:
operationId: getPet
parameters:
- description: 'pet id'
in: query
name: pet_id
required: true
schema:
format: int64
type: integer
style: form
responses:
"200":
content: {}
description: ""
Command line used for generation
for server
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli:latest generate \
-i /local/openapi.yaml \
-g go-server -o /local/go-server
for client
docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli:latest generate \
-i /local/openapi.yaml \
-g go -o /local/go
Steps to reproduce
Related issues/PRs
Suggest a fix
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the provided OpenAPI declaration and compare the generated api_default.go files from the go-server and go generators. Reproduce with the listed Docker commands, trace how the go-server reads the query parameter name, and consider the issue done when both generated sides use "pet_id" consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- api, backend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100