swagger-api/swagger-codegen

Documentation generator for JS client?

Open

#2,079 opened on 2016年2月9日

GitHub で見る
 (7 comments) (0 reactions) (0 assignees)HTML (5,474 forks)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

Repository metrics

Stars
 (12,701 stars)
PR merge metrics
 (30d に merged PR はありません)

説明

The generated client code has nice documentation comments, but I haven't been able to produce any good output from it. Is there actually a JS api doc generator that produces any good output from these sources? I've tried ESDoc, JSDoc, and YUIDoc, and all came out with essentially empty output. Is there a magic tool/configuration combo that works?

コントリビューターガイド

調査方針
swagger codegen によって生成された JavaScript クライアントコードを調査し、JSDoc、ESDoc、YUIDoc などのさまざまなドキュメント生成ツールを異なる設定オプションでテストします。issue コメントを確認して、ヒントや回避策がないか確認してください。クライアントに TypeScript 定義がある場合は TypeDoc の使用を検討するか、OpenAPI 仕様から直接 Markdown ドキュメントを生成する方法を探ります。
技術スタック
javascript
領域
documentation
Issue 種別
調査
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-3時間
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
JavaScript
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
60