swagger-api/swagger-codegen

Add auto-generated documentation

Open

#2,359 opened on 2016年3月11日

GitHub で見る
 (13 comments) (1 reaction) (0 assignees)HTML (12,701 stars) (5,474 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
over 1 week
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.