PHPackages simplecomplex/http - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [HTTP & Networking](/categories/http) 4. / 5. simplecomplex/http ActiveLibrary[HTTP & Networking](/categories/http) simplecomplex/http ================== High-level HTTP client and (Slim) service utility. Client provides response validation and mocking; service provides standardized and predictable responses. 2.2(6y ago)0169MITPHPPHP >=7.0 Since Sep 24Pushed 6y ago2 watchersCompare [ Source](https://github.com/simplecomplex/php-http)[ Packagist](https://packagist.org/packages/simplecomplex/http)[ Docs](https://github.com/simplecomplex/php-http)[ RSS](/packages/simplecomplex-http/feed)WikiDiscussions master Synced 3w ago READMEChangelogDependencies (8)Versions (24)Used By (0) Http ---- [](#http) High-level HTTP client and (Slim) service utility. Client provides response validation and mocking. Service provides standardized and predictable responses. ### ▹ Client [](#-client) #### Request options [](#request-options) The `HttpClient->request()` method accepts it's own options as well as options for the underlying [RestMini Client](https://github.com/simplecomplex/restmini#client-options). ##### Own options [](#own-options) - (bool) **debug\_dump**: log request and response - (bool|arr) **cacheable**: cache response/load response from [cache](https://github.com/simplecomplex/php-cache) - (bool|arr) **validate\_response**: validate the response body against a [validation rule set](https://github.com/simplecomplex/php-validate) - (bool|arr) **mock\_response**: don't send the request, return predefined mock response - (int) **retry\_on\_unavailable**: millisecs; try again later upon 503 Service Unavailable|host not found|connection failed - (arr) **require\_response\_headers**: list of response header keys required - (bool) **err\_on\_endpoint\_not\_found**: err on 404 + HTML response - (bool) **err\_on\_resource\_not\_found**: err on 204 or 404 + JSON response - (arr) **log\_warning\_on\_status**: key is status code, value is true ##### Options processing [](#options-processing) Apart from options passed directly to `HttpClient->request()` there may also exist settings (see [Config](https://github.com/simplecomplex/php-config)) for the: - **provider**: the service host - **service**: a group of endpoints - **endpoint**: the actual endpoint - **method**: literal HTTP method or an alias (like GET aliases index and retrieve) During request preparations settings and options get merged, so that – *options* override *method* settings, which override *endpoint* settings, which override... (you get it). Sounds like a lot of work, but it isn't really. #### ▹▹ Client CLI commands [](#-client-cli-commands) ##### (remote) Service configuration [](#remote-service-configuration) ``` # Show provider settings. php cli.php config-get -a global http-provider.prvdr # Show service settings. php cli.php config-get -a global http-service.prvdr.example-service # Show endpoint settings. php cli.php config-get -a global http-endpoint.prvdr.example-service.ndpnt # Show method settings. php cli.php config-get -a global http-method.prvdr.example-service.ndpnt.GET ``` ##### Validation rule sets [](#validation-rule-sets) ``` # Show cached validation rule set. php cli.php cache-get http-response_validation-rule-set prvdr.example-service.ndpnt.GET # Delete cached validation rule set. php cli.php cache-delete http-response_validation-rule-set prvdr.example-service.ndpnt.GET ``` ##### Mock responses [](#mock-responses) ``` # Show cached mock response. php cli.php cache-get http-response_mock prvdr.example-service.ndpnt.GET # Delete cached mock response. php cli.php cache-delete http-response_mock prvdr.example-service.ndpnt.GET ``` #### ▹▹ Client error codes [](#-client-error-codes) For every error code there's an equivalent prefab safe and user-friendly (localizable) error message. - `unknown`: overall error fallback - `local-unknown`: local error fallback - `local-algo`: in-package logical error - `local-use`: invalid argument et al. - `local-configuration`: bad config var - `local-option`: bad option var - `local-init`: RestMini Client or cURL cannot request - `host-unavailable`: DNS or actually no such host - `service-unavailable`: status 503 Service Unavailable - `too-many-redirects`: too many redirects - `timeout`: cURL 504 - `timeout-propagated`: status 504 Gateway Timeout - `response-none`: cURL 500 (RestMini Client 'response-false') - `remote`: status 500 Internal Server Error - `remote-propagated`: remote says 502 Bad Gateway - `malign-status-unexpected`: unsupported 5xx status - `endpoint-not-found`: status 404 + Content-Type not JSON (probably HTML); no such endpoint - `resource-not-found`: status 204, status 404 + Content-Type JSON; no such resource (object) - `remote-validation-bad`: 400 Bad Request - `remote-validation-failed`: 412 Precondition Failed, 422 Unprocessable Entity - `response-type`: content type mismatch - `response-format`: parse error - `benign-status-unexpected`: unsupported non-5xx status - `header-missing`: setting/option *require\_response\_headers* - `response-validation`: response body validation failure; service will send X-Http-Response-Invalid header ### ▹ Service [](#-service) Producing a service response is not as hard as requesting a remote service, so the service part of **Http** is not as rich as the client part. It is assumed that one will simply echo something and send some headers – or use a service framework like [Slim](https://www.slimframework.com/). The `HttpServiceSlim` class suggest means of interacting with Slim, and **Http** includes a simple example. @todo And **Http** also provides a few other service utilities. #### Allowing Cross Origin requests [](#allowing-cross-origin-requests) Preferably only at development site. Necessary when developing Angular-based frontend. Place a `.cross_origin_allow_sites` text file in document root, containing list allowed sites, like: `http://localhost:4200,http://my-project.build.local.host:80` #### ▹▹ Service error codes [](#-service-error-codes) For every error code there's an equivalent prefab safe and user-friendly (localizable) error message. - `unknown`: overall fallback - `request-unacceptable`: (some kind of) bad request; `HttpResponseRequestUnacceptable` - `unauthenticated`: authentication (login) failure; `HttpResponseRequestUnauthenticated` - `unauthorized`: authorization (permission) failure; `HttpResponseRequestUnauthorized` - `request-validation`: request header/argument validation failure; `HttpResponseRequestInvalid` - `frontend-response-format`: frontend only; parse error - `frontend-response-validation`: frontend only; response validation failure ### Service and client combined [](#service-and-client-combined) #### Standardized wrapped response body [](#standardized-wrapped-response-body) A service requestor should never be in doubt whether a request to your service went alltogether well. `HttpClient->request()` returns `HttpResponse` object: - status `int`: suggested status to send to requestor - headers `array`: suggested headers to send - body `HttpResponseBody` - **success** `bool` - **status** `int`: status received from remote service - **data** `mixed|null`: that actual data (on success) - **message** `string|null`: safe and user-friendly message (on failure) - **code** `int`: error code (on failure), or optionally some other flag (on success) - originalHeaders `array`: headers received – *not* to be sent to requestor - validated `bool|null`: whether the response was validated, and then the outcome The general idea is to always send a response body containing *metadata* about the procedings – success, status, code. And – on failure – a prefab safe and user-friendly message, which the client can use to inform the visitor (instead of just failing silently/ungracefully). When exposing a service that does a remote request, the service should however have access to more detailed info about the remote request/response – therefore the further wrapping in an object that suggests status and headers (et al.). #### ▹ Service response headers [](#-service-response-headers) **Http** uses a number of custom response headers, to flag stuff to the client. Some are issued by `HttpClient` upon every remote request (the original/final statuses). Others are only issued if a service uses/sends one of the prefab `HttpResponse` extensions. - (int)`X-Http-Original-Status`: status received from remote service (or interpretated ditto) - (int)`X-Http-Final-Status`: final status to be sent to client - `X-Http-Response-Invalid`: response validation failure; `HttpResponseResponseInvalid` - `X-Http-Mock-Response`: `HttpClient` never called remote service; used prefab mock response - `X-Http-Request-Invalid`: request header/argument validation failure; `HttpResponseRequestInvalid` - `X-Http-Request-Unacceptable`: (some kind of) bad request; `HttpResponseRequestUnacceptable` - `X-Http-Request-Unauthenticated`: authentication (login) failure; `HttpResponseRequestUnauthenticated` - `X-Http-Request-Unathorized`: authorization (permission) failure; `HttpResponseRequestUnauthorized` ### Requirements [](#requirements) - PHP >=7.0 - [PSR-3 Log](https://github.com/php-fig/log) - [SimpleComplex Utils](https://github.com/simplecomplex/php-utils) - [SimpleComplex Cache](https://github.com/simplecomplex/php-cache) - [SimpleComplex Config](https://github.com/simplecomplex/php-config) - [SimpleComplex Locale](https://github.com/simplecomplex/php-locale) - [SimpleComplex Validate](https://github.com/simplecomplex/php-validate) - [SimpleComplex RestMini](https://github.com/simplecomplex/restmini) - [SimpleComplex Inspect](https://github.com/simplecomplex/inspect) #### Suggestions [](#suggestions) - [Slim](https://github.com/slimphp/Slim) ### Health Score 30 — LowBetter than 62% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community8 Small or concentrated contributor base Maturity68 Established project with proven stability Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~48 days Recently: every ~161 days Total 22 Last Release 2192d ago Major Versions 1.x-dev → 2.02018-06-24 ### Community Maintainers ![](https://www.gravatar.com/avatar/cc4dc35e0d2b8e4619ae2fe2d083cb3c64b09127ecb318c3909025fc0aae1e7f?d=identicon)[jacobfriis](/maintainers/jacobfriis) --- Top Contributors [![jacobfriis](https://avatars.githubusercontent.com/u/3807905?v=4)](https://github.com/jacobfriis "jacobfriis (129 commits)") --- Tags phphttp clienthttp serviceHTTP response mockHTTP response validate ### Embed Badge ![Health badge](/badges/simplecomplex-http/health.svg) ``` [![Health](https://phpackages.com/badges/simplecomplex-http/health.svg)](https://phpackages.com/packages/simplecomplex-http) ``` ### Alternatives [symfony/http-kernel Provides a structured process for converting a Request into a Response 8.1k869.4M8.8k](/packages/symfony-http-kernel)[symfony/http-client Provides powerful methods to fetch HTTP resources synchronously or asynchronously 2.0k338.8M5.0k](/packages/symfony-http-client)[api-platform/metadata API Resource-oriented metadata attributes and factories 275.0M218](/packages/api-platform-metadata)[hyperf/hyperf A coroutine framework that focuses on hyperspeed and flexibility. Building microservice or middleware with ease. 6.9k3.3k2](/packages/hyperf-hyperf)[bitrix24/b24phpsdk An official PHP library for the Bitrix24 REST API 10244.2k5](/packages/bitrix24-b24phpsdk)[mimmi20/browser-detector Library to detect Browsers and Devices 48157.5k5](/packages/mimmi20-browser-detector) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)