Query strings for Go (opinionated!) https://pkg.go.dev/github.com/annybs/go-qs

Aneurin Barker Snook f6793b0746 add test workflow 10 mesiacov pred
.github f6793b0746 add test workflow 10 mesiacov pred
.gitignore 05ba1ccf56 ensure go.sum not committed 10 mesiacov pred
LICENSE.md 0d6091b30c duplicate license to each package 11 mesiacov pred
README.md 2fbbf5d70f fix link to license 10 mesiacov pred
filter.go 7b189b333e start adding more complex filter support 1 rok pred
filter_test.go 7f3dc0c79d add validation error type, fix tests, add number tests 1 rok pred
go.mod 9d3816cfcc rename module 10 mesiacov pred
join.go d94f155714 add qs joins 1 rok pred
join_test.go 7f3dc0c79d add validation error type, fix tests, add number tests 1 rok pred
page.go d94f155714 add qs joins 1 rok pred
page_test.go 7f3dc0c79d add validation error type, fix tests, add number tests 1 rok pred
pagination.go 137dc89f64 rename query package to qs 1 rok pred
pagination_test.go 7f3dc0c79d add validation error type, fix tests, add number tests 1 rok pred
sort.go 137dc89f64 rename query package to qs 1 rok pred
sort_test.go 7f3dc0c79d add validation error type, fix tests, add number tests 1 rok pred

README.md

Go Query String

An opinionated suite of functions to help read common query strings into useful objects, mainly focused on data querying.

This particular package is primarily for the author's own use; if you want to pattern your query strings differently, this library is not for you!

Features

This package includes support for:

  • Filters filter=title eq Bolognese&filter=serves gte 4
  • Joins join=author&join=ingredient
  • Pagination limit=10&offset=5&page=3 (note: offset overrides page)
  • Sorting sort=title asc&sort=serves asc

You can read these individually or use the ReadPage() function to retrieve a convenient Page object that's easy to pass along to your querying code.

Example

package main

import (
	"net/http"

	"github.com/annybs/go/qs"
	"github.com/annybs/go/rest"
)

type Handler struct{}

func (*Handler) ServeHTTP(w http.ResponseWriter, req *http.Request) {
	page, err := qs.ReadPage(req.URL.Query(), nil)
	if err != nil {
		rest.WriteErrorJSON(w, err)
	} else {
		rest.WriteResponseJSON(w, http.StatusOK, page)
	}
}

func main() {
	http.ListenAndServe("localhost:8000", &Handler{})
}

Open http://localhost:8000 in your browser and try different query strings (per Features, above) to see an example response object. You can also enter malformed query strings, which will cause a validation error.

License

See LICENSE.md