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.