swagger-api/swagger-codegen

directory structure of swagger generated code is inappropriate.

Open

#3,383 opened on Jul 15, 2016

View on GitHub
 (1 comment) (1 reaction) (0 assignees)HTML (5,474 forks)batch import
Client: AndroidIssue: Bughelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Directory structure of swagger generated code is inappropriate, when the package name is supplied through config.json using -c option.

I have attached my swagger.yml file.

contents of config.json

{ "invokerPackage" : "in.lxltech", "apiPackage" : "in.lxltech.krayon", "modelPackage" : "in.lxltech.model" }

The command i'm using to generated code:-

java -jar swagger-codegen-cli.jar generate -i swagger.yml -l android --library=volley -o generated_source_code -c config.json

swagger generated code directory structure

in -lxltech -krayon -model

io -swagger -client -auth => files inside this directory have package name as 'in.lxltech.auth' but the directory structure is incorrect -request => files inside this directory have package name as 'in.lxltech.request' but the directory structure is incorrect

=> auth and request folders have to be placed under the directory 'in/lxltech', but it is placing under 'io/swagger/client'

Contributor guide

Research direction
Investigate how the 'invokerPackage', 'apiPackage', and 'modelPackage' options are used in the Android code generator template (mustache files) and the codegen logic to determine output directory structure. The issue indicates that auth and request packages are placed under 'io/swagger/client' instead of the user specified package. Look at the Android code generation templates and the DefaultGenerator or supporting code that resolves the output path for API client and auth files.
Tech stack
javaandroid
Domain
apitooling
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
JavaSwagger/OpenAPIAndroid
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50