Skip to content

Commit d5d5ce7

Browse files
authored
Add docs on the relation between uri methods and request URL (#22)
1 parent 6eda2d9 commit d5d5ce7

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

handler/api/api.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,17 @@ type Request interface {
101101

102102
// GetURI returns the request URI. Ex. "/v1.0/hi?name=panda"
103103
//
104+
// This is analogous to the URL property of http.Request when used server-side.
105+
// Those who wish to use url.URL can parse this with url.ParseRequestURI.
106+
//
104107
// Note: The URI may include query parameters.
105108
GetURI() string
106109

107110
// SetURI overwrites the URI.
108111
//
112+
// This is analogous to setting the URL property of http.Request when used server-side.
113+
// Those who wish to use url.URL can generate it with url.URL.String.
114+
//
109115
// Note: The URI may include query parameters.
110116
SetURI(uri string)
111117

0 commit comments

Comments
 (0)