swagger-api/swagger-codegen

[java-play-framework] Error building the project when config parameters are overridden

Open

#6,867 opened on Nov 2, 2017

View on GitHub
 (14 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Issue: BugServer: Javahelp wanted

Description

Description

We generated the Source code from swagger.yaml , we also have config.json that overrides certain parameters (mentioned below) , When we try to build the code it fails due to overridden params are not reflecting in "Module.java"

Swagger-codegen version

2.3.0

Swagger declaration file content or url

can try with any swagger file (say petstore.yaml)

Command line used for generation

java -jar swagger-codegen-2.3.0 jar -i petstore.yaml -c config.json -l java-play-framework

in config.json add below line to override "apiPackage":"com.puppies.store.apis",

Steps to reproduce

This generates the code , when we build it fails , the cause is because in which Module.java has still older statement

import controllers.*;

ideally , since we overridden "apiPackage" it should be import com.puppies.store.apis.*;

once we changed this manually , we could build it fine . so ideally code generator need to be fixed !

Related issues/PRs
Suggest a fix/enhancement

Contributor guide

Tech stack
java
Domain
toolingapibackend
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
JavaPlay Frameworkswagger codegen internals
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
The issue is in the template that generates Module.java. Look for the template file for the java play framework generator, likely in modules/swagger codegen/src/main/resources/JavaPlayFramework/. The import statement uses a fixed package name instead of the overridden apiPackage. Check how other templates handle the apiPackage override and ensure the import uses the correct variable. Also verify that the config override is being passed to the template context.