grpc-ecosystem/grpc-gateway

docs: Improve documentation about http options

Open

#295 创建于 2017年1月10日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Go (16,971 star) (2,250 fork)batch import
documentationhelp wanted

描述

I keep having to inspect the source code to remember how to declare http options that include values in the path.

贡献者指南

技术栈
gogrpcrest api
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
basic Go knowledgefamiliarity with protobuf
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
75
研究方向
Examine the source code in `runtime/` and `protoc gen grpc gateway/` to understand how HTTP options with path values are parsed. Then locate the documentation (e.g., README or docs folder) and add clear examples showing how to declare options that include values in the path. Verify the examples by testing with the actual code.