swagger-api/swagger-codegen

Markdown supported in swagger-editor but not swagger-codegen

Open

#1,203 opened on Sep 8, 2015

View on GitHub
 (3 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)batch import
Enhancement: Featurehelp wanted

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.

Contributor guide

Tech stack
javarest api
Domain
documentation
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Swagger/OpenAPI basicsJava developmentMarkdown syntax
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
55
Research direction
Investigate how swagger codegen currently renders descriptions in generated HTML. Look at the Mustache templates (e.g., index.mustache) to see where description fields are used. Explore adding a Markdown to HTML conversion step, possibly using a library like CommonMark. Check if any existing configuration options exist for markdown processing.