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