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 (12,701 stars) (5,474 forks)batch import
Client: AndroidIssue: Bughelp wanted

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

Tech stack
androidjavarest api
Domain
toolingapi
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.
1-3 hours
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
Basic knowledge of OpenAPI/SwaggerUnderstanding of Java package structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Examine the Android template files in the swagger codegen repository, specifically the 'mustache' templates that map package names to directory structures. Look for how the 'invokerPackage', 'apiPackage', and 'modelPackage' values are used to generate the output directory hierarchy. The issue mentions that 'auth' and 'request' folders are placed under 'io/swagger/client' instead of under the specified package path. Investigate the template for 'auth' and 'request' related classes (likely in the Android library with Volley). The only comment (if any) may provide additional context; check issue #3383 for any follow up. The fix likely involves correcting the template variable used for the base directory output.