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.