swagger-api/swagger-codegen

Output template variables as single JSON

Open

#2 553 ouverte le 11 avr. 2016

Voir sur GitHub
 (15 commentaires) (0 réactions) (0 assignés)HTML (5 474 forks)batch import
Enhancement: Featurehelp wanted

Métriques du dépôt

Stars
 (12 701 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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?

Guide contributeur

Direction de recherche
Examinez comment les variables de template sont actuellement émises lorsque DdebugModels et DdebugOperations sont utilisés séparément. Ensuite, examinez la branche fournie (kenjitayama:singleJSONDebugInfo) pour comprendre la logique de fusion. Implémentez une nouvelle option outputTemplateVariables qui génère toutes les variables de template sous forme d'un seul objet JSON, permettant une intégration plus facile avec des moteurs de template comme EJS.
Stack technique
javajavascript
Domaine
developer experienceapi
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JavaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75