swagger-api/swagger-codegen

Markdown supported in swagger-editor but not swagger-codegen

Open

#1.203 geöffnet am 8. Sept. 2015

Auf GitHub ansehen
 (3 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

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.

Contributor Guide

Research-Richtung
Untersuche die HTML Generierungsvorlage und füge mit einer Markdown Bibliothek Markdown Rendering für Beschreibungsfelder hinzu.
Tech Stack
javahtml
Domain
documentationapi
Issue Type
Fehler
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
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
Java
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
70