Lightweight API httprouter middleware: cors, logging, and standardized error handling.
CI / CD
|
|
Quality
|
|
Security
|
|
Community
|
|
🚀 Installation
|
🧪 Examples & Tests
|
📚 Documentation
|
🤝 Contributing
|
🛠️ Code Standards
|
⚡ Benchmarks
|
🤖 AI Usage
|
⚖️ License
|
👥 Maintainers
|
go-api-router requires a supported release of Go.
go get github.com/mrz1836/go-api-routerView the generated documentation
- Uses the fastest router: Julien Schmidt's httprouter
- Uses gofr's uuid package to guarantee unique request ids
- Uses MrZ's go-logger for either local or remote logging via Log Entries (Rapid7)
- Uses MrZ's go-parameters for parsing any type of incoming parameter with ease
- Optional: NewRelic support!
- Added basic middleware support from Rileyr's middleware
- Optional: JWT Authentication (middleware)
- Added additional CORS functionality
- Standardized error responses for API requests
- Centralized logging on all requests (requesting user info and request time)
- Custom response writer for Etag and cache support
GetClientIPAddress()safely detects IP addresses behind load balancersGetParams()parses parameters only onceFilterMap()removes any confidential parameters from logs- ...and more!
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 fuzz tests run via GitHub Actions and use Go version 1.25.x. View the configuration file.
Run all tests (fast):
magex testRun all tests with race detector (slower):
magex test:raceRun 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 |
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! 🚀
