📘  go-parameters

Parameter multi-tool that parses json, msg pack, or multipart form data into a parameter object.

CI / CD		Quality
Security		Community

go-parameters requires a supported release of Go.

go get -u github.com/mrz1836/go-parameters

View the generated documentation

• This package uses the fastest router: Julien Schmidt's httprouter
• Works with json, msgpack, and multi-part forms
• Handles all standard types for GetParams
• Handler methods like MakeParsedReq() for httprouter use
• Imbue and Permit helper methods
• GetParams() parses parameters only once

# Install MAGE-X for development and building
go install github.com/mrz1836/mage-x/cmd/magex@latest
magex update:install

brew install goreleaser

magex version:bump bump=patch push

magex help

magex deps:update

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 test

Run all tests with race detector (slower):

magex test:race

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

• UniqueUint64: Measures the performance of generating unique uint64 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:

magex bench

Read more about this Go project's code standards.

This project documents expectations for AI assistants using a few dedicated files:

• AGENTS.md — canonical rules for coding style, workflows, and pull requests used by Codex.
• CLAUDE.md — quick checklist for the Claude agent.
• .cursorrules — machine-readable subset of the policies for Cursor and similar tools.
• sweep.yaml — rules for Sweep, a tool for code review and pull request management.

Edit AGENTS.md first when adjusting these policies, and keep the other files in sync within the same pull request.

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! 🚀