What problem does it solve?
Provides a structured, testable way to perform HTTP requests from ColdBox and BoxLang applications, removing boilerplate around authentication, timeouts, response parsing, and error handling when integrating with external REST APIs.
Core Features & Use Cases
- Injection & Fluent Builder: Inject HyperBuilder and compose requests with base URLs, headers, query params, and timeouts.
- Request Shortcuts & Body Types: Simple GET/POST/PUT/PATCH/DELETE shortcuts plus JSON, form-encoded, and raw bodies.
- Response Handling & Errors: Inspect status codes, parse JSON safely, map 4xx/5xx to typed exceptions, and implement retry/timeouts.
- Production Patterns: Build reusable API client services, cache OAuth tokens, and log contextual errors for reliable integrations.
- Use Case: Wrap a third-party payments or identity API in a service that handles auth, token caching, and consistent error mapping.
Quick Start
Inject HyperBuilder, set a base URL and headers, then call get or post to fetch or submit JSON to an external API.