Parameter multi-tool that parses json, msg pack, or multipart form data into a parameter object.
CI / CD
|
|
Quality
|
|
Security
|
|
Community
|
|
🚀 Installation
|
🧪 Examples & Tests
|
📚 Documentation
|
🤝 Contributing
|
🛠️ Code Standards
|
⚡ Benchmarks
|
🤖 AI Usage
|
⚖️ License
|
👥 Maintainers
|
go-parameters requires a supported release of Go.
go get -u github.com/mrz1836/go-parametersView the generated documentation
- This package 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
Development Setup (Getting Started)
Install MAGE-X build tool for development:
# Install MAGE-X for development and building
go install github.com/mrz1836/mage-x/cmd/magex@latest
magex update:installLibrary Deployment
This project uses goreleaser for streamlined binary and library deployment to GitHub. To get started, install it via:
brew install goreleaserThe release process is defined in the .goreleaser.yml configuration file.
Then create and push a new Git tag using:
magex version:bump bump=patch push=true branch=masterThis process ensures consistent, repeatable releases with properly versioned artifacts and citation metadata.
Build Commands
View all build commands
magex helpGitHub Workflows
All workflows are driven by modular configuration in .github/env/ — no YAML editing required.
Updating Dependencies
To update all dependencies (Go modules, linters, and related tools), run:
magex deps:updateThis command ensures all dependencies are brought up to date in a single step, including Go modules and any managed tools. It is the recommended way to keep your development environment and CI in sync with the latest versions.
All unit tests and examples run via GitHub Actions and use Go version 1.24.x. View the configuration file.
Run all tests (fast):
magex testRun all tests with race detector (slower):
magex test:raceThe 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 uniqueuint64values.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:
magex benchRead more about this Go project's code standards.
Read the AI Usage & Assistant Guidelines for details on how AI is used in this project and how to interact with AI assistants.
 |
 |
|---|---|
| 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! 🚀
