commit	933e771185ac05d912951a52c38ccb6277e4bbb2	[log] [tgz]
author	Will Norris <will@willnorris.com>	Mon Mar 01 17:01:55 2021
committer	Will Norris <will@willnorris.com>	Mon Mar 01 17:01:55 2021
tree	4a1e4ea68cece8059e4eafa226853f8f999f5f56
parent	1f8679d4b6ae8af19ebe15a3cc5a5a82d61c2d0d [diff]

tree: 4a1e4ea68cece8059e4eafa226853f8f999f5f56

README.md

go-querystring

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

Usage

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:

type opt struct {
  Query   string `url:"q"`
  ShowAll bool   `url:"all"`
  Page    int    `url:"page"`
}

v, _ := query.Values(opt{"foo", true, 2})
fmt.Print(v.Encode()) // will output: "q=foo&all=true&page=2"

Supported types and options

The package godocs are the authoritative source for documentation on supported types and formatting options, but illustrative examples are provided here as well.

booleans

By default, boolean values are encoded as the words “true” or “false”:

type opt struct {
  V bool `url:"v"`
}

query.Values(opt{true}) // result: "v=true"

Adding the int option causes the field to be encoded as a “1” or “0”:

type opt struct {
  V bool `url:v,int`
}

query.Values(opt{false}) // result: "v=0"

time

By default, time values are encoded as RFC3339 timestamps:

type opt struct {
  V time.Time `url:"v"`
}

query.Values(opt{false}) // result: "v=0"

Adding the unix option encodes as a UNIX timestamp (seconds since Jan 1, 1970)

type opt struct {
  V time.Time `url:"v,unix"`
}

query.Values(opt{false}) // result: "v=0"

Alternatives

If you are looking for a library that can both encode and decode query strings, you might consider one of these alternatives: