swagger-api/swagger-codegen

Output template variables as single JSON

Open

#2,553 opened on Apr 11, 2016

View on GitHub
 (15 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: Featurehelp wanted

Description

Currently, when both -DdebugModels and -DdebugOperations are used, template variables are output as separate JSONs.

If they are merged as a single JSON, it would be easier for developers to use their favorite template engines, such as EJS. Actually, I am having a hard time writing mustache templates to match our own client HTTP library, and I am starting to use EJS.

I am using this modification to accomplish this. https://github.com/swagger-api/swagger-codegen/compare/master...kenjitayama:singleJSONDebugInfo

For this use case, output would be input for other scripts, not just for debug information. So maybe an option like --outputTemplateVariables (without needing -DdebugModels and -DdebugOperations) would make more sense.

How do you think of this kind of output?

Contributor guide

Tech stack
java
Domain
toolingdeveloper experience
Issue type
feature
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-2 days
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.
mostly clear
Prerequisites
Knowledge of Swagger Codegen's template systemFamiliarity with Java or Mustache/EJS
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Review the existing debug model and debug operations output logic in the swagger codegen codebase. Examine the linked branch 'kenjitayama:singleJSONDebugInfo' to understand a proposed implementation. Consider whether a new option like ` outputTemplateVariables` is needed or if merging can be done automatically. The main files involved are in the code generation template engine, likely in Java classes handling debug output.
Output template variables as single JSON · swagger-api/swagger-codegen#2553 | Good First Issue