mirror of
https://github.com/Luzifer/repo-template.git
synced 2024-09-20 17:42:58 +00:00
40 lines
1.2 KiB
Markdown
40 lines
1.2 KiB
Markdown
# go-querystring #
|
|
|
|
go-querystring is Go library for encoding structs into URL query parameters.
|
|
|
|
|
|
**Documentation:** <http://godoc.org/github.com/google/go-querystring/query>
|
|
**Build Status:** [](https://drone.io/github.com/google/go-querystring/latest)
|
|
|
|
## Usage ##
|
|
|
|
```go
|
|
import "github.com/google/go-querystring/query"
|
|
```
|
|
|
|
go-querystring is designed to assist in scenarios where you want to construct a
|
|
URL using a struct that represents the URL query parameters. You might do this
|
|
to enforce the type safety of your parameters, for example, as is done in the
|
|
[go-github][] library.
|
|
|
|
The query package exports a single `Values()` function. A simple example:
|
|
|
|
```go
|
|
type Options struct {
|
|
Query string `url:"q"`
|
|
ShowAll bool `url:"all"`
|
|
Page int `url:"page"`
|
|
}
|
|
|
|
opt := Options{ "foo", true, 2 }
|
|
v, _ := query.Values(opt)
|
|
fmt.Print(v.Encode()) // will output: "q=foo&all=true&page=2"
|
|
```
|
|
|
|
[go-github]: https://github.com/google/go-github/commit/994f6f8405f052a117d2d0b500054341048fbb08
|
|
|
|
## License ##
|
|
|
|
This library is distributed under the BSD-style license found in the [LICENSE](./LICENSE)
|
|
file.
|