.NET Разработчик on Telegram: “День 2214. #ЗаметкиНаПолях Создаём Надёжных Клие…”

День 2214. #ЗаметкиНаПолях
Создаём Надёжных Клиентов API с Refit. Продолжение
Начало

Параметры запроса
При работе с API часто требуется отправлять данные как часть URL либо в маршруте, либо в строке запроса. Refit делает этот процесс простым и типобезопасным. Добавим в IBlogApi пару более сложных сценариев:

public interface IBlogApi
{
  // …

  [Get("/posts")]
  Task<List<Post>> GetPostsAsync(
   [Query] Filters filters);

  [Get("/users/{userId}/posts")]
  Task<List<Post>> GetUserPostsAsync(int userId);
}

public record Filters(int? UserId, string? Title);

Здесь:
- GetPostsAsync использует объект для представления фильтров запроса. Это подходит для конечных точек со множеством необязательных параметров. Refit автоматически преобразует этот объект в строку запроса. Использование объекта для фильтров запроса делает код типобезопасным и удобным для рефакторинга. Если нужно добавить новый фильтр запроса, просто добавьте свойство в Filters.
- GetUserPostsAsync демонстрирует передачу параметров в маршрут.

Динамические заголовки и аутентификация
Ещё одним распространённым требованием при интеграции с API является включение пользовательских заголовков или токенов аутентификации в запросы. Refit предоставляет несколько способов сделать это: от простых статических заголовков до динамической аутентификации, специфичной для запроса.

public interface IBlogApi
{
  [Headers("User-Agent: MyAwesomeApp/1.0")]
  [Get("/posts")]
  Task<List<Post>> GetPostsAsync();

  [Get("/secure-posts")]
  Task<List<Post>> GetSecurePostsAsync(
   [Header("Authorization")] string bearerToken);

  [Get("/user-posts")]
  Task<List<Post>> GetUserPostsAsync(
   [Authorize(scheme: "Bearer")] string token);
}

- можно добавить статический заголовок ко всем запросам, используя атрибут метода Headers;
- с помощью атрибута параметра Header можно передавать значение заголовка в качестве параметра;
- атрибут параметра Authorize — удобный способ добавить аутентификацию через токен.

А если нужно добавить один и тот же динамический заголовок ко всем запросам, можно использовать DelegatingHandler.

Настройки JSON-сериализации
Refit дает гибкость при выборе и настройке JSON-сериализации. По умолчанию он использует System.Text.Json, но можно легко переключиться на Newtonsoft.Json, установив NuGet-пакет Refit.Newtonsoft.Json и настроив клиента:

builder.Services.AddRefitClient<IBlogApi>(
 new RefitSettings {
  ContentSerializer = 
   new NewtonsoftJsonContentSerializer(
    new JsonSerializerSettings
    {
      ContractResolver = new CamelCasePropertyNamesContractResolver(),
      NullValueHandling = NullValueHandling.Ignore
    })
})
.ConfigureHttpClient(…);

Здесь мы настроили camelcase для имён свойств и игноририрование нулевых значений при сериализации.
System.Text.Json быстрее и использует меньше памяти, что делает его отличным выбором по умолчанию. Однако Newtonsoft.Json предлагает больше функций и может быть необходим для совместимости со старыми системами или для особых потребностей сериализации.

Окончание следует…

Источник: https://www.milanjovanovic.tech/blog/refit-in-dotnet-building-robust-api-clients-in-csharp