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.
Document protoc-gen-swagger · grpc-ecosystem/grpc-gateway#427 | Good First Issue