swagger-api/swagger-codegen

Documentation generator for JS client?

Open

#2,079 建立於 2016年2月9日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)HTML (12,701 star) (5,474 fork)batch import
Client: JavaScript/Node.jsEnhancement: Featurehelp wanted

描述

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?

貢獻者指南

技術棧
javascript
領域
documentation
議題類型
research
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-3 hours
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
JavaScriptJSDoc/ESDocSwagger codegen
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
25
研究方向
Investigate the generated JavaScript client code from swagger codegen and test various documentation generators like JSDoc, ESDoc, and YUIDoc with different configuration options. Review the issue comments for any hints or workarounds. Consider using TypeDoc if the client has TypeScript definitions, or explore generating Markdown documentation directly from the OpenAPI spec.