OpenAPITools / OpenAPITools/openapi-generator

[BUG][GO] go-server generates api-files with unused imports

Open
#11,097 6 comments 1 reaction 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

if api does not include path-parameters
files "api_***.go" includes unused imports: "encoding/json" and "github.com/go-chi/chi/v5" or "github.com/gorilla/mux" (depends on selected routed)

if you remove these unused imports generated project can be compiled

openapi-generator version

5.3.0

OpenAPI declaration file content or url

https://app.swaggerhub.com/apis/acceleratedlife/alife/1.0.0

Generation Details

java -jar ./openapi-generator-cli-5.3.0.jar generate -i acceleratedLife-1.0.0-resolved.json -g go-server -o path\

Steps to reproduce

once code generated need to populate package-name in main.go
and run 'go build'

compiler will show the errors:

go\api_users.go:14:2: imported and not used: "encoding/json"
go\api_users.go:18:2: imported and not used: "github.com/go-chi/chi/v5" as chi
Related issues/PRs
Suggest a fix

change a template:
https://github.com/OpenAPITools/openapi-generator/blob/master/modules/openapi-generator/src/main/resources/go-server/controller-api.mustache

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 with modules/openapi-generator/src/main/resources/go-server/controller-api.mustache and generate the go-server output using the linked OpenAPI declaration and the documented CLI command. Run go build after setting package-name in main.go, then inspect the generated api_*.go imports. Done means generated projects for APIs without path parameters compile without unused-import errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
api, backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.