swagger-api/swagger-codegen

Markdown supported in swagger-editor but not swagger-codegen

Aberta

#1.203 aberto em 8 de set. de 2015

Ver no GitHubGuia do colaborador
 (3 comentários) (0 reação) (0 responsável)HTML (5.474 forks)batch import
Enhancement: Featurehelp wanted

Métricas do repositório

Stars
 (12.701 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

Description

I can use Markdown in several places in my API spec (in YAML) to enter detailed descriptions, and swagger-editor will interpret it and display it correctly. However, when I put the resulting spec (in JSON) into swagger-codegen, it doesn't convert the markdown while generating a static HTML page. As far as I can tell, swagger-codegen doesn't accept YAML, so the end result is that I have to do extensive reformatting to convert my spec to HTML documentation. This has to be fixed.

Guia do colaborador

Direção de pesquisa
Investigue o template de geração HTML e adicione a renderização Markdown aos campos de descrição usando uma biblioteca Markdown.
Pilha de tecnologia
javahtml
Domain
documentationapi
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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
Java
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70