Csibi Norbert
Csibi Norbert

Reputation: 930

Why HttpClient does not hold the base address even when it`s set in Startup

In my ASP.NET Core Web API project, I would like to hit an external API so that I get my response as expected.

The way I'm registering and using the HttpClient is as follows: in the startup, I'm adding this code which defines a typed HttpClient:

services.AddHttpClient<IRecipeService, RecipeService>(c => {
                c.BaseAddress = new Uri("https://sooome-api-endpoint.com");
                c.DefaultRequestHeaders.Add("x-raay-key", "123567890754545645gggg");
                c.DefaultRequestHeaders.Add("x-raay-host", "sooome-api-endpoint.com");
            });

In addition to this, I have a service class into which I inject a HttpClient:

public class RecipeService : IRecipeService
{
    private readonly HttpClient _httpClient;

    public RecipeService(HttpClient httpClient)
    {
        _httpClient = httpClient;
    }

    public async Task<List<Core.Dtos.Recipes>> GetReBasedOnIngAsync(string endpoint)
    {
        using (var response = await _httpClient.GetAsync(recipeEndpoint))
        {
            // ...
        }
    }
}

When the HttpClient is created, if I hover over the object itself, the base URI/Headers are missing, and I don't understand why exactly this is happening. I would appreciate if someone could show some light :)

UPDATE #1

The service is being used in one of the controllers shown below. The service is injected by the DI and then the relative path is parsed to the service (I assumed I already have the base URL stored in the client). Maybe I`m doing it wrong?

namespace ABC.Controllers
{
    [ApiController]
    [Route("[controller]")]
    public class FridgeIngredientController : ControllerBase
    {
        private readonly IRecipeService _recipeService;
        private readonly IMapper _mapper;

        public FridgeIngredientController(IRecipeService recipeService, IMapper mapper)
        {
            _recipeService = recipeService;
            _mapper = mapper;
        }

        [HttpPost("myingredients")]
        public async Task<ActionResult> PostIngredients(IngredientsDto ingredientsDto)
        {
            var readyUrIngredientStr = string.Join("%2", ingredientsDto.ingredients);

            var urlEndpoint = $"recipes/findByIngredients?ingredients={readyUrIngredientStr}";
            var recipesResponse = await _recipeService.GetRecipeBasedOnIngredientsAsync(urlEndpoint);

            InMyFridgeRecipesDto recipesFoundList = new InMyFridgeRecipesDto
            {
                FoundRecipes = recipesResponse
            };

            return Ok(recipesFoundList);
        }
    }
}

Any suggestions?

Upvotes: 19

Views: 22172

Answers (6)

akshay_zz
akshay_zz

Reputation: 77

As @LIFEfreedom has pointed out. Order of registration will show some effect. But why? If we register the type client after the service we are injecting it will work. The reason type client is registering the service once again. So multiple services are getting injected. But as we know DI provides you last registered service that's why it is working if the type client is registered at the end.

The simple solution to fix the actual issue is to not register the service separately. AddHttpClient will do it for you. As I'm aware type client register services as transient so be sure before using it.

// Do not register this
// services.AddTransient<HttpService>();

// This will automatically register HttpService.
services.AddHttpClient<HttpService>(client =>
{
    client.BaseAddress = new Uri(baseAdress);
});```


Upvotes: 2

Psalm23
Psalm23

Reputation: 31

I experienced this and what worked for me was using the interface and concrete implementation of my service like this instead of using just the concrete class:

services.AddHttpClient<**ICategoryManager, CategoryManager**>(httpClient => 
{ 
        httpClient.BaseAddress = new Uri("https://sooome-api-endpoint.com/categories"); 
}); 

Upvotes: 3

Serge
Serge

Reputation: 43959

You configured your client as a typed client and not a named client. No need for the factory.

You should explicitly inject the http client in constructor instead, not the http client factory.

Change your code to this:

private readonly HttpClient _httpClient;

public ReService(HttpClient httpClient) {
    _httpClient = httpClient;
}

public async Task<List<Core.Dtos.Re>> GetReBasedOnIngAsync(string endpoint)
{

    ///Remove this from your code
    var client = _httpClientFactory.CreateClient(); <--- HERE the base URL/Headers are missing
    
    var request = new HttpRequestMessage
    {
        Method = HttpMethod.Get,
        RequestUri = new Uri(endpoint)
    };
    //////

    using (var response = await _httpClient.GetAsync(endpoint))
    {
        // ...
    }
}

And according to last MS documentation only the typed client registration is needed in this case. Fix your startup to this:

// services.AddScoped<IReService, ReService>(); //<-- REMOVE. NOT NEEDED
services.AddHttpClient<IReService, ReService>(c => ...

But you still can try to add you base address, please add trailing slash (and let us know if it still works):

services.AddHttpClient<IReService, ReService>(c => {
                c.BaseAddress = new Uri("https://sooome-api-endpoint.com/");
                 });

if problem still persists I recommend you to try named http clients.

Upvotes: 13

Jack
Jack

Reputation: 1006

A simple, frustrating reason this may happen is due to the order of your service collection statements.

Assigning the dependant service after the HTTPClient will not work, it must come before:

// NOT WORKING - BaseAddress is null
services.AddTransient<Controller1>();
services.AddTransient<Controller2>();

services.AddHttpClient<HttpService>(client =>
{
    client.BaseAddress = new Uri(baseAdress);
});

services.AddTransient<HttpService>();


// WORKING - BaseAddress is not null
services.AddTransient<Controller1>();
services.AddTransient<Controller2>();
services.AddTransient<HttpService>();

services.AddHttpClient<HttpService>(client =>
{
    client.BaseAddress = new Uri(baseAdress);
});

EDIT

As LIFEfreedom rightfully pointed out in their answer: while the order of the statements has an effect here, it is not the reason for behaviour.

Both of the following statements create a transient service for the HttpService class:

services.AddTransient<HttpService>();
services.AddHttpClient<HttpService>();

However, when adding both of these statements only the latest one will be used, overwriting any statements before it. In my example, I only got the expected result when the AddHttpClient statement with the base address configuration came last.

Upvotes: 29

LIFEfreedom
LIFEfreedom

Reputation: 53

@jack wrote a comment and several guys supported him that this is the right decision, but it is the wrong decision.

AddHttpClient creates a TService service as a Transient service, to which it passes an HttpClient created only for it

Calling first AddTransient, and then AddHttpClient<>, you add 2 implementations of one dependency and only the last added one will be returned

// Create first dependency
services.AddTransient<HttpService>();

// Create second and last dependency
services.AddHttpClient<HttpService>(client =>
{
    client.BaseAddress = new Uri(baseAdress);
});

Upvotes: 4

Csibi Norbert
Csibi Norbert

Reputation: 930

Okay so I will answer my post because with the suggested TYPED way of doing it was causing problems with the values not being set inside the httpClient, E.G BaseAddress was always null.

In the startup I was trying to go with typed httpclient e.g

services.AddHttpClient<IReService, ReService>(c => ...

But instead of doing that, I choose the to go with the Named client. Which means that in the startup we need to register the httpclient like this

services.AddHttpClient("recipeService", c => {
....

And then in the service itself I used HttpClientFactory like below.

 private readonly IHttpClientFactory _httpClientFactory;

        public RecipeService(IHttpClientFactory httpClientFactory)
        {
            _httpClientFactory = httpClientFactory;
        }

        public async Task<List<Core.Dtos.Recipes>> GetRecipeBasedOnIngredientsAsync(string recipeEndpoint)
        {
            var client = _httpClientFactory.CreateClient("recipeService");

            using (var response = await client.GetAsync(client.BaseAddress + recipeEndpoint))
            {
                response.EnsureSuccessStatusCode();

                var responseRecipies = await response.Content.ReadAsStringAsync();
                var recipeObj = ConvertResponseToObjectList<Core.Dtos.Recipes>(responseRecipies);

                return recipeObj ?? null;
            }
        }

Upvotes: 7

Related Questions