grpc-ecosystem/grpc-gateway

Document protoc-gen-swagger

Open

#427 创建于 2017年7月4日

在 GitHub 查看
 (5 评论) (0 反应) (0 负责人)Go (2,250 fork)batch import
documentationhelp wantedopenapi

仓库指标

Star
 (16,971 star)
PR 合并指标
 (平均合并 8天 23小时) (30 天内合并 147 个 PR)

描述

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
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
1
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1 小时以内
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
活跃
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
ProtobufGo
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
90