grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 opened on 2017年7月4日

GitHub で見る
 (5 comments) (0 reactions) (0 assignees)Go (2,250 forks)batch import
documentationhelp wantedopenapi

Repository metrics

Stars
 (16,971 stars)
PR merge metrics
 (平均マージ 8d 23h) (30d で 147 merged PRs)

説明

There's no obvious documentation on how to actually comment .proto files so they can be parsed by protoc-gen-swagger. It'd be useful if some was added.

コントリビューターガイド

調査方針
リポジトリ内の既存のドキュメント、特に README とサンプルを確認してください。protoc gen swagger プラグインのソースコードを調べて、コメントの解析方法を理解します。.proto ファイルにおける一般的な Swagger アノテーションの例を提供し、その効果を説明してください。
技術スタック
go
領域
backendapi
Issue 種別
ドキュメント
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
1
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1時間未満
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
アクティブ
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
明確
前提条件
ProtobufGo
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
90