swagger-api/swagger-codegen

Markdown supported in swagger-editor but not swagger-codegen

Open

#1,203 opened on 2015年9月8日

GitHub で見る
 (3 comments) (0 reactions) (0 assignees)HTML (12,701 stars) (5,474 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.