swagger-api/swagger-codegen

Output template variables as single JSON

Open

#2.553 geöffnet am 11. Apr. 2016

Auf GitHub ansehen
 (15 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)HTML (5.474 Forks)batch import
Enhancement: Featurehelp wanted

Repository-Metriken

Stars
 (12.701 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuchen Sie, wie Template Variablen derzeit ausgegeben werden, wenn DdebugModels und DdebugOperations separat verwendet werden. Überprüfen Sie dann den bereitgestellten Branch (kenjitayama:singleJSONDebugInfo), um die Merge Logik zu verstehen. Implementieren Sie eine neue Option outputTemplateVariables, die alle Template Variablen als ein einzelnes JSON Objekt ausgibt, um die Integration mit Template Engines wie EJS zu erleichtern.
Tech Stack
javajavascript
Domain
developer experienceapi
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
JavaGit
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75