swagger-api/swagger-codegen

Output template variables as single JSON

Open

#2.553 aberto em 11 de abr. de 2016

Ver no GitHub
 (15 comments) (0 reactions) (0 assignees)HTML (5.474 forks)batch import
Enhancement: Featurehelp wanted

Métricas do repositório

Stars
 (12.701 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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?

Guia do colaborador

Direção de pesquisa
Observe como as variáveis de template são atualmente geradas quando DdebugModels e DdebugOperations são usados separadamente. Em seguida, examine o branch fornecido (kenjitayama:singleJSONDebugInfo) para entender a lógica de mesclagem. Implemente uma nova opção outputTemplateVariables que gera todas as variáveis de template como um único objeto JSON, permitindo integração mais fácil com mecanismos de template como EJS.
Pilha de tecnologia
javajavascript
Domain
developer experienceapi
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JavaGit
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75