https://github.com/google/go-querystring

go-querystring is Go library for encoding structs into URL query strings.
https://github.com/google/go-querystring

query-string querystring

Last synced: 7 days ago
JSON representation

go-querystring is Go library for encoding structs into URL query strings.

• Host: GitHub
• URL: https://github.com/google/go-querystring
• Owner: google
• License: bsd-3-clause
• Created: 2013-09-10T19:26:51.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2024-10-03T13:37:07.000Z (about 1 month ago)
• Last Synced: 2024-10-12T23:06:34.670Z (23 days ago)
• Topics: query-string, querystring
• Language: Go
• Homepage: https://pkg.go.dev/github.com/google/go-querystring/query
• Size: 64.5 KB
• Stars: 1,976
• Watchers: 26
• Forks: 172
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-ccamel - google/go-querystring - go-querystring is Go library for encoding structs into URL query strings. (Go)
• go-awesome - go-querystring - Convert structure to URL request parameters (Open source library / Redirect)
• awesome-go - go-querystring - Go library for encoding structs into URL query parameters. Stars:`2.0K`. (Text Processing / Parsers/Encoders/Decoders)
• my-awesome - google/go-querystring - string,querystring pushed_at:2024-10 star:2.0k fork:0.2k go-querystring is Go library for encoding structs into URL query strings. (Go)

README

        
# go-querystring #

[![Go Reference](https://pkg.go.dev/badge/github.com/google/go-querystring/query.svg)](https://pkg.go.dev/github.com/google/go-querystring/query)

[![Test Status](https://github.com/google/go-querystring/workflows/tests/badge.svg)](https://github.com/google/go-querystring/actions?query=workflow%3Atests)

[![Test Coverage](https://codecov.io/gh/google/go-querystring/branch/master/graph/badge.svg)](https://codecov.io/gh/google/go-querystring)

go-querystring is a Go library for encoding structs into URL query parameters.

## 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"

```

See the [package godocs][] for complete documentation on supported types and

formatting options.

[go-github]: https://github.com/google/go-github/commit/994f6f8405f052a117d2d0b500054341048fbb08

[package godocs]: https://pkg.go.dev/github.com/google/go-querystring/query

## Alternatives ##

If you are looking for a library that can both encode and decode query strings,

you might consider one of these alternatives:

 - https://github.com/gorilla/schema

 - https://github.com/pasztorpisti/qs

 - https://github.com/hetiansu5/urlquery

 - https://github.com/ggicci/httpin (decoder only)