swagger-api/swagger-codegen

Add auto-generated documentation

オープン

#2,359 opened on 2016/03/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

Repository metrics

Stars
 (12,701 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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
Issue 種別
機能
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2日
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
Basic programming skillsFamiliarity with chosen languageUnderstanding of Swagger/OpenAPI
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
70