swagger-api/swagger-codegen

Add auto-generated documentation

Open

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

在 GitHub 查看
 (13 留言) (1 反應) (0 負責人)HTML (12,701 star) (5,474 fork)batch import
Client: BashClient: C++Client: ClojureClient: Flash/ActionScriptClient: GroovyClient: ScalaClient: SwiftClient: TypeScriptEnhancement: FeatureFeature List: API clientsFeature: Documentationhelp wanted

描述

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:

貢獻者指南

技術棧
cppswiftscalatypescript
領域
documentation
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
over 1 week
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Familiarity with the target languageUnderstanding of swagger codegen templating system
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45
研究方向
Examine the existing auto generated documentation implementation for languages that are already complete, such as Perl (#2320, #2343) and others linked. Understand the template structure and how documentation files are generated. Then apply the same pattern to the chosen target language (e.g., C++ or TypeScript). Check the repository's contribution guidelines for any specific requirements.
Add auto-generated documentation · swagger-api/swagger-codegen#2359 | Good First Issue