grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 建立於 2017年7月4日

在 GitHub 查看
 (5 留言) (0 反應) (0 負責人)Go (16,971 star) (2,250 fork)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
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
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.