Document recommended DI usage

[aradalvand]

What is the optimal way of using MeilisearchClient with ASP.NET Core's DI container? It would be helpful if this was documented, or even better, if the library shipped with extension methods on IServiceCollection (e.g. AddMeilisearchClient).

It's also a bit tricky to use MeilisearchClient with .AddHttpClient, since you also need to pass the apiKey through the constructor. Currently, I have had to do this:

builder.Services.AddHttpClient(nameof(MeilisearchClient), client =>
{
    client.BaseAddress = new("<server-url>");
}).AddTypedClient<MeilisearchClient>(client => new(
    client,
    "<api-key>"
));

Update: I just found out that using the constructor that receives an HttpClient means the MeilisearchMessageHandler won't be registered on the client, and consequently, Meilisearch-specific exceptions like MeilisearchApiError won't be thrown.
This is problematic and really confusing. This area is in dire need of some refinement.

[brunoocasali]

@ahmednfwela could I have your opinion on this case? I personally never used DI on C#

[ahmednfwela]

First I like to store all meilisearch related configs in a separate class

public class MeilisearchConfig
{
    public string Url { get; set; }
    public string ApiKey { get; set; }
}

Then, configuring the services

var hostBuilder = Host.CreateDefaultBuilder(args)
            .ConfigureServices((context, services) =>
            {   
                // Configure meilisearch settings (either in code or via configuration).
                // Option 1
                // IConfiguration meilisearchConfig = context.Configuration.GetRequiredSection("meilisearch");
                // services.Configure<MeilisearchConfig>(meilisearchConfig);
                // Option 2
                services.Configure<MeilisearchConfig>((config) =>
                {
                    config.Url = "http://localhost:7700";
                    config.ApiKey = "masterKey";
                });

                // Add MeilisearchMessageHandler
                services.AddTransient<MeilisearchMessageHandler>();

                // Add a named HttpClient for MeilisearchClient.             
                services.AddHttpClient(nameof(MeilisearchClient), (sp, client) =>
                {
                    var config = sp.GetRequiredService<IOptions<MeilisearchConfig>>().Value;
                    //configure the http client
                    client.BaseAddress = new Uri(config.Url);
                }).AddTypedClient<MeilisearchClient>((client, sp) =>
                {
                    var config = sp.GetRequiredService<IOptions<MeilisearchConfig>>().Value;
                    return new MeilisearchClient(client, config.ApiKey);
                }).AddHttpMessageHandler<MeilisearchMessageHandler>();
            });