swagger-api/swagger-codegen

Add auto-generated documentation

開放

#2,359 建立於 2016年3月11日

在 GitHub 查看貢獻者指南
 (13 則留言) (1 個反應) (0 位負責人)HTML (5,474 個分叉)batch import
Client: BashClient: C++Client: ClojureClient: Flash/ActionScriptClient: GroovyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: FeatureFeature List: API clientsFeature: Documentationhelp wanted

倉庫指標

星標
 (12,701 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

We've add capabilities to generate documentation files (markdown) for API and model files in the Perl code generator: #2320, #2343

If anyone has cycle to add the documentation to the following languages, please reply to let us know:

貢獻者指南

研究方向
檢查現有的 Perl 文件生成實現（相關 PR），然後為你選擇的語言（Bash、C++ 等）實現類似功能。確保更新程式碼生成器模板並添加必要的測試。
技術棧
java
領域
documentation
議題類型
功能
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Basic programming skillsFamiliarity with chosen languageUnderstanding of Swagger/OpenAPI
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
70