grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 opened on 2017年7月4日

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

説明

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.

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

技術スタック
gorest api
領域
documentation
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
stale
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
understanding of Protocol Buffersfamiliarity with .proto files
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
75
調査方針
Review the existing documentation in the repository, particularly the README and any examples. Examine the protoc gen swagger plugin's source code to understand how it parses comments. Provide examples of common swagger annotations in .proto files and explain their effects.