You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

39 lines
1.2 KiB

  1. # go-querystring #
  2. go-querystring is Go library for encoding structs into URL query parameters.
  3. **Documentation:** <http://godoc.org/github.com/google/go-querystring/query>
  4. **Build Status:** [![Build Status](https://drone.io/github.com/google/go-querystring/status.png)](https://drone.io/github.com/google/go-querystring/latest)
  5. ## Usage ##
  6. ```go
  7. import "github.com/google/go-querystring/query"
  8. ```
  9. go-querystring is designed to assist in scenarios where you want to construct a
  10. URL using a struct that represents the URL query parameters. You might do this
  11. to enforce the type safety of your parameters, for example, as is done in the
  12. [go-github][] library.
  13. The query package exports a single `Values()` function. A simple example:
  14. ```go
  15. type Options struct {
  16. Query string `url:"q"`
  17. ShowAll bool `url:"all"`
  18. Page int `url:"page"`
  19. }
  20. opt := Options{ "foo", true, 2 }
  21. v, _ := query.Values(opt)
  22. fmt.Print(v.Encode()) // will output: "q=foo&all=true&page=2"
  23. ```
  24. [go-github]: https://github.com/google/go-github/commit/994f6f8405f052a117d2d0b500054341048fbb08
  25. ## License ##
  26. This library is distributed under the BSD-style license found in the [LICENSE](./LICENSE)
  27. file.