swagger-api/swagger-codegen

Markdown supported in swagger-editor but not swagger-codegen

Open

#1,203 创建于 2015年9月8日

在 GitHub 查看
 (3 评论) (0 反应) (0 负责人)HTML (12,701 star) (5,474 fork)batch import
Enhancement: Featurehelp wanted

描述

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.

贡献者指南

技术栈
javarest api
领域
documentation
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Swagger/OpenAPI basicsJava developmentMarkdown syntax
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
55
研究方向
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.