go-parameters
Parameter multi-tool that parses json, msg pack, or multi-part form data into a parameter object.
Table of Contents
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
Installation
go-parameters requires a supported release of Go.
go get -u github.com/mrz1836/go-parameters
Documentation
View the generated documentation
Features
- Uses the fastest router: Julien Schmidt's httprouter
- Works with
json,msgpack, andmulti-partforms - Handles all standard types for
GetParams - Handler methods like
MakeParsedReq()forhttprouteruse ImbueandPermithelper methodsGetParams()parses parameters only once
Package Dependencies
- Gorilla's mux package.
- Julien Schmidt's httprouter package.
- Ugorji's go codec package.
Library Deployment
goreleaser for easy binary or library deployment to Github and can be installed via: brew install goreleaser.
The .goreleaser.yml file is used to configure goreleaser.
Use make release-snap to create a snapshot version of the release, and finally make release to ship to production.
Makefile Commands
View all makefile commands
make help
List of all current commands:
all Runs multiple commands
clean Remove previous builds and any test cache data
clean-mods Remove all the Go mod cache
coverage Shows the test coverage
godocs Sync the latest tag with GoDocs
help Show this help message
install Install the application
install-go Install the application (Using Native Go)
lint Run the golangci-lint application (install if not found)
release Full production release (creates release in Github)
release Runs common.release then runs godocs
release-snap Test the full release (build binaries)
release-test Full production test release (everything except deploy)
replace-version Replaces the version in HTML/JS (pre-deploy)
run-examples Runs all the examples
tag Generate a new tag and push (tag version=0.0.0)
tag-remove Remove a tag if found (tag-remove version=0.0.0)
tag-update Update an existing tag to current commit (tag-update version=0.0.0)
test Runs vet, lint and ALL tests
test-ci Runs all tests via CI (exports coverage)
test-ci-no-race Runs all tests via CI (no race) (exports coverage)
test-ci-short Runs unit tests via CI (exports coverage)
test-short Runs vet, lint and tests (excludes integration tests)
uninstall Uninstall the application (and remove files)
update-linter Update the golangci-lint package (macOS only)
vet Run the Go vet application
Examples & Tests
All unit tests and examples run via Github Actions and uses Go version 1.15.x. View the configuration file.
Run all tests (including integration tests)
make test
Run tests (excluding integration tests)
make test-short
Benchmarks
Run the Go benchmarks:
make bench
Code Standards
Read more about this Go project's code standards.
Usage
View the examples
Basic implementation:
package main
import (
"fmt"
"log"
"net/http"
"github.com/julienschmidt/httprouter"
"github.com/mrz1836/go-parameters"
)
func Hello(w http.ResponseWriter, req *http.Request) {
params := parameters.GetParams(req)
name, _ := params.GetStringOk("name")
_, _ = fmt.Fprintf(w, `{"hello":"%s"}`, name)
}
func main() {
router := httprouter.New()
router.GET("/hello/:name", parameters.GeneralJSONResponse(Hello))
log.Fatal(http.ListenAndServe(":8080", router))
}
Maintainers
 |
 |
|---|---|
| MrZ | kayleg |
Contributing
View the contributing guidelines and please follow the code of conduct.
How can I help?
All kinds of contributions are welcome
