Parameter multi-tool that parses json, msg pack, or multipart form data into a parameter object.
- Installation
- Documentation
- Examples & Tests
- Benchmarks
- Code Standards
- Usage
- Maintainers
- Contributing
- License
go-parameters requires a supported release of Go.
go get -u github.com/mrz1836/go-parameters
View the generated documentation
- Uses the fastest router: Julien Schmidt's httprouter
- Works with
json
,msgpack
, andmulti-part
forms - Handles all standard types for
GetParams
- Handler methods like
MakeParsedReq()
forhttprouter
use Imbue
andPermit
helper 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
All unit tests and examples run via GitHub Actions and uses Go version 1.19.x. View the configuration file.
Run all tests (including integration tests)
make test
Run tests (excluding integration tests)
make test-short
The following benchmarks were conducted to measure the performance of various functions in the github.com/mrz1836/go-parameters
package. All tests were run on a machine with the following specifications:
- Operating System: macOS (Darwin)
- Architecture: ARM64
- CPU: Apple M1 Max
View the latest benchmark results
Benchmark | Iterations | ns/op | B/op | allocs/op |
---|---|---|---|---|
UniqueUint64 | 13,989,841 | 84.49 ns | 64 B | 1 |
GetParams_ParseJSONBody | 209,700,817 | 5.721 ns | 0 B | 0 |
GetParams | 209,668,894 | 5.719 ns | 0 B | 0 |
Params_GetStringOk | 37,573,434 | 31.96 ns | 16 B | 1 |
Params_GetBoolOk | 36,349,316 | 33.15 ns | 16 B | 1 |
Params_GetBytesOk | 38,539,616 | 31.52 ns | 16 B | 1 |
Params_GetBool | 35,637,433 | 32.57 ns | 16 B | 1 |
Params_GetFloatOk | 22,064,586 | 54.69 ns | 16 B | 1 |
Params_GetIntOk | 28,992,304 | 41.78 ns | 16 B | 1 |
Params_GetInt64Ok | 28,752,844 | 41.77 ns | 16 B | 1 |
Params_GetIntSliceOk | 38,099,671 | 31.59 ns | 16 B | 1 |
Params_GetUint64Ok | 29,921,580 | 39.68 ns | 16 B | 1 |
UniqueUint64
: Measures the performance of generating uniqueuint64
values.GetParams_ParseJSONBody
: Benchmarks parsing a JSON body into parameters.GetParams
: Tests retrieving parameters without parsing.Params_GetStringOk
: Evaluates fetching a string parameter with success indication.Params_GetBoolOk
: Assesses fetching a boolean parameter with success indication.Params_GetBytesOk
: Measures retrieving a byte slice parameter with success indication.Params_GetBool
: Benchmarks fetching a boolean parameter without success indication.Params_GetFloatOk
: Tests fetching a float parameter with success indication.Params_GetIntOk
: Evaluates fetching an integer parameter with success indication.Params_GetInt64Ok
: Measures fetching a 64-bit integer parameter with success indication.Params_GetIntSliceOk
: Benchmarks retrieving a slice of integers with success indication.Params_GetUint64Ok
: Tests fetching an unsigned 64-bit integer parameter with success indication.
- Iterations: The number of times the benchmark function was executed.
- ns/op: Nanoseconds per operation, indicating the average time taken for each operation.
- B/op: Bytes allocated per operation, showing the memory usage.
- allocs/op: Allocations per operation, indicating how many memory allocations occurred per operation.
Run the Go benchmarks:
make bench
Read more about this Go project's code standards.
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))
}
MrZ | kayleg |
View the contributing guidelines and please follow the code of conduct.
All kinds of contributions are welcome π! The most basic way to show your support is to star π the project, or to raise issues π¬. You can also support this project by becoming a sponsor on GitHub π or by making a bitcoin donation to ensure this journey continues indefinitely! π