swagger-api/swagger-codegen

Markdown supported in swagger-editor but not swagger-codegen

Open

#1203 aperta il 8 set 2015

Vedi su GitHub
 (3 commenti) (0 reazioni) (0 assegnatari)HTML (5474 fork)batch import
Enhancement: Featurehelp wanted

Metriche repository

Star
 (12.701 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Investiga il template di generazione HTML e aggiungi il rendering Markdown ai campi di descrizione usando una libreria Markdown.
Tech stack
javahtml
Dominio
documentationapi
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Java
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70