GuzzleHttp\Client ignores base path in base_url

Question

I'm using Guzzle in a set of PHPUnit-powered tests for a REST API.

I create my client as follows:

use GuzzleHttp\Client;

$client = new Client(['base_url' => ['http://api.localhost/api/{version}', ['version' => '1.0']]]);

This works fine, and I can make requests using the following code:

$request = $client->createRequest('GET', '/auth');
$request->setBody(Stream::factory(json_encode(['test'=>'data'])));
$response = $client->send($request);
$decodedResponse = $response->json();

However, Guzzle is ignoring the /api/{version} part of the base URL and makes the request to here:

http://api.localhost/auth

However, I would have expected it to make the request here:

http://api.localhost/api/1.0/auth

Have I mis-read the documentation and my expected behaviour is thus wrong, or is there some other option I need to enable to get it to append the /auth url to the /api/1.0 base path when making the request?

https://stackoverflow.com/a/30874624/10043987 solved my problem — ofri cofri, Feb 17 '21 at 10:19

score 24 · Answer 1 · edited Oct 07 '21 at 05:49

24

You're using an absolute path in your requests, so it's overriding the path set in the base URL. Guzzle follows RFC 3986 when combining URLs: https://www.rfc-editor.org/rfc/rfc3986#section-5.2

edited Oct 07 '21 at 05:49

Community

1
1

answered Aug 13 '14 at 16:32

Michael Dowling

5,098
4
32
28

I knew it would be something obvious. Thanks. :) – Benjamin Nolan Aug 13 '14 at 17:15
So what did you do? Just forget the template service and move on with your life? – puppyFlo Sep 18 '14 at 16:42
13

I'm not sure what that means. You just need to remove the leading "/" from URLs to make them relative to the base URL's path. – Michael Dowling Sep 21 '14 at 19:00
3

Thanks @MichaelDowling. Mind putting that last comment in your answer? – Ascherer Mar 23 '15 at 01:54
5

I also had to add a trailing slash to my `base_uri` - Guzzle 6 – Mike McLin Sep 20 '16 at 09:26

score 12 · Accepted Answer · answered Mar 07 '22 at 11:54

Here are examples for Guzzle 7 (7.4.1) of what Michael Dowling wrote

$client = new Client(['base_uri' => 'http://my-app.com/api/']);
$response = $client->get('facets'); // no leading slash - append to base
//    http://my-app.com/api/facets

$client = new Client(['base_uri' => 'http://my-app.com/api/']);
$response = $client->get('facets/'); // no leading slash - append to base // ending slash preserved
//    http://my-app.com/api/facets/

$client = new Client(['base_uri' => 'http://my-app.com/api/']);
$response = $client->get('/facets'); // leading slash - absolute path - base path is lost
//    http://my-app.com/facets

$client = new Client(['base_uri' => 'http://my-app.com/api']); // no ending slash in base path - ignored
$response = $client->get('facets');
//    http://my-app.com/facets

$client = new Client(['base_uri' => 'http://my-app.com/api']);
$response = $client->get('/facets'); // leading slash - absolute path - base path is lost
//    http://my-app.com/facets

I've switched this to the accepted answer as the examples are really helpful. :) — Benjamin Nolan, Jun 08 '23 at 17:56

score 6 · Answer 3 · answered Aug 17 '18 at 17:39

6

I have a sort of oblique answer that might help someone who's predisposed to the same type of typos as I am.

It's base_uri, and that's "uri". Not base_url, as in "url".

The consequence of setting a base_url is similar to the problem described by OP - the request won't build on the configured base.

answered Aug 17 '18 at 17:39

Cameron Hurd

4,836
1
22
31

1

As a side note, in 2014 when the issue occurred, it was `base_url` with an L. The current version uses `base_uri`. My issue was that I was starting the call itself with an initial slash, so instead of getting calls to http://api.localhost/api/{version}/auth as expected, I was getting calls to http://api.localhost/auth. – Benjamin Nolan Aug 23 '18 at 01:51

GuzzleHttp\Client ignores base path in base_url

3 Answers3