<dependency>
    <groupId>io.github.openfeign</groupId>
    <artifactId>feign-core</artifactId>
    <version>??feign.version??</version>
</dependency>

interface GitHub {
  @RequestLine("GET /repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo);
```  @RequestLine("POST /repos/{owner}/{repo}/issues")
  void createIssue(Issue issue, @Param("owner") String owner, @Param("repo") String repo);

}

public static class Contributor {
  String login;
  int contributions;
}

public static class Issue {
  String title;
  String body;
  List<String> assignees;
  int milestone;
  List<String> labels;
}

public class MyApp {
  public static void main(String... args) {
    GitHub github = Feign.builder()
                         .decoder(new GsonDecoder())
                         .target(GitHub.class, "https://api.github.com");

    // Получаем и выводим список вкладчиков этого репозитория.
    List<Contributor> contributors = github.contributors("OpenFeign", "feign");
    for (Contributor contributor : contributors) {
      System.out.println(contributor.login + " (" + contributor.contributions + ")");
    }
  }
}

public interface GitHub {

  @RequestLine("GET /repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repository);

  class Contributor {
    String login;
    int contributions;
  }
}

public class MyApp {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                         .decoder(new GsonDecoder())
                         .target(GitHub.class, "https://api.github.com");

    /* Параметры owner и repo будут использоваться для расширения выражений owner и repo, определенных в RequestLine.
     *
     * Результатом будет URI https://api.github.com/repos/OpenFeign/feign/contributors
     */
    github.contributors("OpenFeign", "feign");
  }
}

{;who}             ;who=fred
{;half}            ;half=50%25
{;empty}           ;empty
{;list}            ;list=red;list=green;list=blue
{;map}             ;semi=%3B;dot=.;comma=%2C

public interface MatrixService {

  @RequestLine("GET /repos{;owners}")
  List<Contributor> contributors(@Param("owners") List<String> owners);

  class Contributor {
    String login;
    int contributions;
  }
}

public void test() {
   Map<String, Object> parameters = new LinkedHashMap<>();
   parameters.put("param", "");
   this.demoClient.test(parameters);
}

http://localhost:8080/test?param=

{;who}             ;who=fred
{;half}            ;half=50%25
{;empty}           ;empty
{;list}            ;list=red;list=green;list=blue
{;map}             ;semi=%3B;dot=.;comma=%2C

public interface MatrixService {

  @RequestLine("GET /repos{;owners}")
  List<Contributor> contributors(@Param("owners") List<String> owners);

  class Contributor {
    String login;
    int contributions;
  }
}

public void test() {
   Map<String, Object> parameters = new LinkedHashMap<>();
   parameters.put("param", "");
   this.demoClient.test(parameters);
}

http://localhost:8080/test?param=
```*Отсутствующее значение*
```java
public void test() {
   Map<String, Object> parameters = new LinkedHashMap<>();
   this.demoClient.test(parameters);
}

http://localhost:8080/test

public void test() {
   Map<String, Object> parameters = new LinkedHashMap<>();
   parameters.put("param", null);
   this.demoClient.test(parameters);
}

http://localhost:8080/test

Результат этого метода следует тем же правилам, что и выше. Если результат равен `null` или пустой строке, значение опускается. Если значение не закодировано в percent-encoded, оно будет закодировано. См. [Пользовательское расширение @Param](#custom-param-expansion) для дополнительных примеров.

#### Расширение заголовков запроса

Шаблоны `Headers` и `HeaderMap` следуют тем же правилам, что и [Расширение параметров запроса](#request-parameter-expansion), с некоторыми изменениями:

* Неразрешённые выражения опускаются. Если результат равен пустому значению заголовка, весь заголовок удаляется.
* Не выполняется кодирование в percent-encoded.

См. [Заголовки](#headers) для примеров.

> **Примечание к параметрам @Param и их именам**:
>
> Все выражения с одинаковым именем, независимо от их положения в `@RequestLine`, `@QueryMap`, `@BodyTemplate`, или `@Headers`, будут разрешаться к одному и тому же значению.
> В следующем примере значение `contentType` будет использоваться для разрешения как заголовка, так и выражения пути:
>
> ```java
> public interface ContentService {
>   @RequestLine("GET /api/documents/{contentType}")
>   @Headers("Accept: {contentType}")
>   String getDocumentByType(@Param("contentType") String type);
> }
>```
>
> Имейте это в виду при проектировании ваших интерфейсов.

#### Расширение тела запроса

Шаблоны `Body` следуют тем же правилам, что и [Расширение параметров запроса](#request-parameter-expansion), с некоторыми изменениями:* Неразрешённые выражения опускаются.
* Расширенное значение **не** будет передано через `Encoder` перед тем, как быть добавлено в тело запроса.
* Должен быть указан заголовок `Content-Type`. См. [Шаблоны тела](#body-templates) для примеров.

---
### Пользовательские Настройки

Feign имеет несколько аспектов, которые можно настроить.  
Для простых случаев вы можете использовать `Feign.builder()` для создания интерфейса API с вашими пользовательскими компонентами.<br>
Для настройки запроса вы можете использовать `options(Request.Options options)` на `target()` для установки `connectTimeout`, `connectTimeoutUnit`, `readTimeout`, `readTimeoutUnit`, `followRedirects`.<br>
Для примера:
```java
interface Bank {
  @RequestLine("POST /account/{id}")
  Account getAccountInfo(@Param("id") String id);
}

public class BankService {
  public static void main(String[] args) {
    Bank bank = Feign.builder()
        .decoder(new AccountDecoder())
        .options(new Request.Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, true))
        .target(Bank.class, "https://api.examplebank.com");
  }
}

public class CloudService {
  public static void main(String[] args) {
    CloudDNS cloudDNS = Feign.builder()
      .target(new CloudIdentityTarget<CloudDNS>(user, apiKey));
  }
```  class CloudIdentityTarget extends Target<CloudDNS> {
    /* реализация класса Target */
  }
}

public class Example {
  public static void main(String[] args) {
    GsonCodec codec = new GsonCodec();
    GitHub github = Feign.builder()
                         .encoder(new GsonEncoder())
                         .decoder(new GsonDecoder())
                         .target(GitHub.class, "https://api.github.com");
  }
}

public class Example {
  public static void main(String[] args) {
      GitHub github = Feign.builder()
                     .encoder(new JacksonEncoder())
                     .decoder(new JacksonDecoder())
                     .target(GitHub.class, "https://api.github.com");
  }
}

#### Sax
[SaxDecoder](./sax) позволяет декодировать XML таким образом, чтобы это было совместимо с обычной JVM и также с Android-окружением.

Вот пример конфигурации парсинга ответа Sax:
```java
public class Example {
  public static void main(String[] args) {
      Api api = Feign.builder()
         .decoder(SAXDecoder.builder()
                            .registerContentHandler(UserIdHandler.class)
                            .build())
         .target(Api.class, "https://apihost");
    }
}

public class Example {
  public static void main(String[] args) {
    Api api = Feign.builder()
             .encoder(new JAXBEncoder())
             .decoder(new JAXBDecoder())
             .target(Api.class, "https://apihost");
  }
}

public class Example {
  public static void main(String[] args) {
    Api api = Feign.builder()
                    .encoder(new SOAPEncoder(jaxbFactory))
                    .decoder(new SOAPDecoder(jaxbFactory))
                    .errorDecoder(new SOAPErrorDecoder())
                    .target(MyApi.class, "http://api");
  }
}
```Примечание: возможно, вам также потребуется добавить `SOAPErrorDecoder`, если SOAP Faults возвращаются в ответе с ошибочными HTTP-кодами (400, 500, ...).#### Fastjson2 

[fastjson2](./fastjson2) включает в себя кодировщик и декодировщик, которые можно использовать с API JSON.

Добавьте `Fastjson2Encoder` и/или `Fastjson2Decoder` к вашему `Feign.Builder` следующим образом:

```java
public class Example {
  public static void main(String[] args) {
      GitHub github = Feign.builder()
                     .encoder(new Fastjson2Encoder())
                     .decoder(new Fastjson2Decoder())
                     .target(GitHub.class, "https://api.github.com");
  }
}

interface GitHub {
  @GET @Path("/repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@PathParam("owner") String owner, @PathParam("repo") String repo);
}

public class Example {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                       .contract(new JAXRSContract())
                       .target(GitHub.class, "https://api.github.com");
  }
}

public class Example {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                     .client(new OkHttpClient())
                     .target(GitHub.class, "https://api.github.com");
  }
}
```#### Ribbon
[RibbonClient](./ribbon) переопределяет разрешение URL клиента Feign, добавляя возможности умного маршрутизирования и устойчивости, предоставляемые [Ribbon](https://github.com/Netflix/ribbon).

Интеграция требует передачи имени клиента Ribbon как части хоста URL, например `myAppProd`.
```java
public class Example {
  public static void main(String[] args) {
    MyService api = Feign.builder()
          .client(RibbonClient.create())
          .target(MyService.class, "https://myAppProd");
  }
}

GitHub github = Feign.builder()
                     .client(new Http2Client())
                     .target(GitHub.class, "https://api.github.com");

public class Example {
  public static void main(String[] args) {
    MyService api = HystrixFeign.builder().target(MyService.class, "https://myAppProd");
  }
}

### Декодеры
`Feign.builder()` позволяет вам указывать дополнительные настройки, такие как способ декодирования ответа.

Если какие-либо методы в вашем интерфейсе возвращают типы, отличные от `Response`, `String`, `byte[]` или `void`, вам потребуется настроить декодер, отличный от стандартного.

Вот как настроить декодирование JSON (используя расширение `feign-gson`):

```java
public class Example {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                     .decoder(new GsonDecoder())
                     .target(GitHub.class, "https://api.github.com");
  }
}

public class Example {
  public static void main(String[] args) {
    JsonpApi jsonpApi = Feign.builder()
                         .mapAndDecode((response, type) -> jsonpUnwrap(response, type), new GsonDecoder())
                         .target(JsonpApi.class, "https://some-jsonp-api.com");
  }
}

```java

public class Пример {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
            .decoder(StreamDecoder.create((r, t) -> {
              BufferedReader bufferedReader = new BufferedReader(r.body().asReader(StandardCharsets.UTF_8));
              return bufferedReader.lines().iterator();
            }, (r, t) -> "это делегированный декодер"))
            .target(GitHub.class, "https://api.github.com");
  }
}

interface LoginClient {
  @RequestLine("POST /")
  @Headers("Content-Type: application/json")
  void login(String content);
}

public class Пример {
  public static void main(String[] args) {
    client.login("{\"user_name\": \"denominator\", \"password\": \"secret\"}");
  }
}

static class Credentials {
  final String user_name;
  final String password;

  Credentials(String user_name, String password) {
    this.user_name = user_name;
    this.password = password;
  }
}

interface LoginClient {
  @RequestLine("POST /")
  void login(Credentials creds);
}

public class Пример {
  public static void main(String[] args) {
    LoginClient client = Feign.builder()
                              .encoder(new GsonEncoder())
                              .target(LoginClient.class, "https://foo.com");

    client.login(new Credentials("denominator", "secret"));
  }
}

### Заголовки
Feign поддерживает установку заголовков в запросах как часть API или клиента в зависимости от сценария использования.

#### Установка заголовков с помощью API
В случаях, когда определенные интерфейсы или вызовы всегда должны иметь определенные значения заголовков, имеет смысл определять заголовки как часть API.

Статические заголовки могут быть установлены на интерфейсе API или методе с помощью аннотации `@Headers`.

```java
@Headers("Accept: application/json")
interface BaseApi<V> {
  @Headers("Content-Type: application/json")
  @RequestLine("PUT /api/{key}")
  void put(@Param("key") String key, V value);
}

public interface Api {
   @RequestLine("POST /")
   @Headers("X-Ping: {token}")
   void post(@Param("token") String token);
}
```В случаях, когда ключи и значения заголовков динамические, а диапазон возможных ключей неизвестен заранее и может варьироваться между различными вызовами методов в одном и том же API/клиенте (например, пользовательские заголовки метаданных, такие как "x-amz-meta-\*" или "x-goog-meta-\*"), параметр типа `Map` может быть аннотирован `HeaderMap`, чтобы создать запрос, использующий содержимое карты как параметры заголовков.```java
public interface Api {
   @RequestLine("POST /")
   void post(@HeaderMap Map<String, Object> headerMap);
}

  static class DynamicAuthTokenTarget<T> implements Target<T> {
    public DynamicAuthTokenTarget(Class<T> clazz,
                                  UrlAndTokenProvider provider,
                                  ThreadLocal<String> requestIdProvider);

    @Override
    public Request apply(RequestTemplate input) {
      TokenIdAndPublicURL urlAndToken = provider.get();
      if (input.url().indexOf("http") != 0) {
        input.insert(0, urlAndToken.publicURL);
      }
      input.header("X-Auth-Token", urlAndToken.tokenId);
      input.header("X-Request-ID", requestIdProvider.get());

      return input.request();
    }
  }

  public class Example {
    public static void main(String[] args) {
      Bank bank = Feign.builder()
              .target(new DynamicAuthTokenTarget(Bank.class, provider, requestIdProvider));
    }
  }
```Эти подходы зависят от использования кастомного `RequestInterceptor` или `Target`, который устанавливается на клиенте Feign при его построении и может использоваться как способ установки заголовков для всех вызовов API на основе каждого клиента. Это может быть полезно для таких вещей, как установка токена аутентификации в заголовке всех вызовов API на основе каждого клиента. Методы выполняются при вызове API на потоке, который вызывает API, что позволяет динамически устанавливать заголовки в момент вызова и в контекстно-зависимом режиме — например, можно использовать потокобезопасное хранилище для установки различных значений заголовков в зависимости от вызывающего потока, что может быть полезно для таких вещей, как установка уникальных идентификаторов трассировки для каждого потока.

#### Установка нулевого заголовка Content-Length

Для указания заголовка `Content-Length: 0` при отправке запроса с пустым телом, системная переменная `sun.net.http.allowRestrictedHeaders` должна быть установлена в значение `true`.

Если этого не сделать, заголовок `Content-Length` не будет добавлен.

### Расширенное использование

#### Основные API
В большинстве случаев API для сервиса следуют одному и тому же соглашению. Feign поддерживает это через интерфейсы с одиночным наследованием.

Рассмотрим пример:
```java
interface BaseAPI {
  @RequestLine("GET /health")
  String health();
```  @RequestLine("GET /all")
  List<Entity> all();
}

interface CustomAPI extends BaseAPI {
  @RequestLine("GET /custom")
  String custom();
}

@Headers("Accept: application/json")
interface BaseApi<V> {

  @RequestLine("GET /api/{key}")
  V get(@Param("key") String key);

  @RequestLine("GET /api")
  List<V> list();

  @Headers("Content-Type: application/json")
  @RequestLine("PUT /api/{key}")
  void put(@Param("key") String key, V value);
}

interface FooApi extends BaseApi<Foo> { }

interface BarApi extends BaseApi<Bar> { }

public class Example {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                     .decoder(new GsonDecoder())
                     .logger(new Logger.JavaLogger("GitHub.Logger").appendToFile("logs/http.log"))
                     .logLevel(Logger.Level.FULL)
                     .target(GitHub.class, "https://api.github.com");
  }
}

Еще один распространенный пример интерцептора — это аутентификация, например, использование встроенного `BasicAuthRequestInterceptor`.

```java
public class Example {
  public static void main(String[] args) {
    Bank bank = Feign.builder()
                      .decoder(accountDecoder)
                      .requestInterceptor(new BasicAuthRequestInterceptor(username, password))
                      .target(Bank.class, "https://api.examplebank.com");
  }
}

public interface Api {
  @RequestLine("GET /?since={date}") Result list(@Param(value = "date", expander = DateToMillis.class) Date date);
}

public interface Api {
  @RequestLine("GET /find")
  V find(@QueryMap Map<String, Object> queryMap);
}

public interface Api {
  @RequestLine("GET /find")
  V find(@QueryMap CustomPojo customPojo);
}
```Когда используется таким образом, без указания пользовательского `QueryMapEncoder`, карта запросов будет генерироваться с использованием имен членов переменных как имен параметров запроса. Вы можете аннотировать конкретное поле `CustomPojo` аннотацией `@Param`, чтобы указать другое имя для параметра запроса. Следующий объект POJO сгенерирует параметры запроса вида "/find?name={name}&number={number}&region_id={regionId}" (порядок включенных параметров запроса не гарантируется, и как обычно, если любое значение равно null, оно будет опущено).

```java
public class CustomPojo {
  private final String name;
  private final int number;
  @Param("region_id")
  private final String regionId;
}
```  public CustomPojo(String name, int number, String regionId) {
    this.name = name;
    this.number = number;
    this.regionId = regionId;
  }
}

public class Example {
  public static void main(String[] args) {
    MyApi myApi = Feign.builder()
                 .queryMapEncoder(new MyCustomQueryMapEncoder())
                 .target(MyApi.class, "https://api.hostname.com");
  }
}

public class Example {
  public static void main(String[] args) {
    MyApi myApi = Feign.builder()
                 .queryMapEncoder(new BeanQueryMapEncoder())
                 .target(MyApi.class, "https://api.hostname.com");
  }
}

public class Example {
  public static void main(String[] args) {
    MyApi myApi = Feign.builder()
                 .errorDecoder(new MyErrorDecoder())
                 .target(MyApi.class, "https://api.hostname.com");
  }
}
```Все ответы, которые приводят к HTTP-статусу, не входящему в диапазон 2xx, будут запускать метод `decode` класса `ErrorDecoder`, что позволит вам обрабатывать ответ, обёртывать ошибку в пользовательское исключение или выполнять любую дополнительную обработку. Если вы хотите повторить запрос, выбросьте исключение `RetryableException`. Это вызовет зарегистрированный `Retryer`.### Повторная отправка
По умолчанию Feign автоматически повторяет `IOException`-и, независимо от HTTP-метода, рассматривая их как временные сетевые исключения, а также любые `RetryableException`, выброшенные из `ErrorDecoder`. Чтобы настроить это поведение, зарегистрируйте пользовательский экземпляр `Retryer` через конструктор.

В следующем примере показано, как обновлять токен и повторять запрос с использованием `ErrorDecoder` и `Retryer` при получении ответа с кодом 401.

```java
public class Пример {
    public static void main(String[] args) {
        var github = Feign.builder()
                .decoder(new GsonDecoder())
                .retryer(new МойПовторитель(100, 3))
                .errorDecoder(new МойОбработчикОшибок())
                .target(ГитХаб.class, "https://api.github.com");

        var вкладчики = github.вкладчики("foo", "bar", "invalid_token");
        for (var вкладчик : вкладчики) {
            System.out.println(вкладчик.login + " " + вкладчик.вклад);
        }
    }

    static class МойОбработчикОшибок implements ErrorDecoder {

        private final ErrorDecoder стандартныйОбработчикОшибок = new Default();

        @Override
        public Exception decode(String methodKey, Response response) {
            // обертка 401 в RetryableException для повторной попытки
            if (response.status() == 401) {
                return new RetryableException(response.status(), response.reason(), response.request().httpMethod(), null, response.request());
            }
            return стандартныйОбработчикОшибок.decode(methodKey, response);
        }
    }

    static class МойПовторитель implements Retryer {

        private final long период;
        private final int максимальноеКоличествоПопыток;
        private int попытка = 1;

        public МойПовторитель(long период, int максимальноеКоличествоПопыток) {
            this.период = период;
            this.максимальноеКоличествоПопыток = максимальноеКоличествоПопыток;
        }

        @Override
        public Retryer clone() {
            return new МойПовторитель(период, максимальноеКоличествоПопыток);
        }

        @Override
        public void attempt(Retryer.Context context) {
            if (попытка >= максимальноеКоличествоПопыток) {
                throw new RetryException("Превышено максимальное количество попыток");
            }
            попытка++;
            try {
                Thread.sleep(период);
            } catch (InterruptedException e) {
                Thread.currentThread().interrupt();
                throw new RetryException("Повторная попытка прервана", e);
            }
        }
    }
}
``````markdown
```java
    public class МойПовторитель {
        public МойПовторитель(long период, int максимальное_количество_попыток) {
            this.период = период;
            this.максимальное_количество_попыток = максимальное_количество_попыток;
        }

        @Override
        public void продолжитьИлиПередать(RetryableException e) {
            if (++попытка > максимальное_количество_попыток) {
                throw e;
            }
            if (e.status() == 401) {
                // удалить Authorization, чтобы Feign не добавлял новый заголовок Authorization
                // поскольку GitHub отвечает 400 bad request
                e.request().requestTemplate().removeHeader("Authorization");
                e.request().requestTemplate().header("Authorization", "Bearer " + получитьНовыйТокен());
                try {
                    Thread.sleep(период);
                } catch (InterruptedException ex) {
                    throw e;
                }
            } else {
                throw e;
            }
        }

        // Получение нового токена из внешнего API
        // В этом примере мы можем просто вернуть фиксированный токен, чтобы продемонстрировать работу Retryer
        private String получитьНовыйТокен() {
            return "newToken";
        }
    }
}
``````java
    @Override
    public Retryer клонировать() {
        return new МойПовторитель(период, максимальное_количество_попыток);
    }
}

public interface Api {
  // возвращает ответ  Yöntem 302
  @RequestLine("GET /location")
  String location();
}

public class MyApp {
  public static void main(String[] args) {
    // Настройте HTTP-клиент для игнорирования перенаправлений
    Api api = Feign.builder()
                   .options(new Options(10, TimeUnit.SECONDS, 60, TimeUnit.SECONDS, false))
                   .responseInterceptor(new RedirectionInterceptor())
                   .target(Api.class, "https://redirect.example.com");
  }
}

public class MyApp {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                         .addCapability(new Metrics4Capability())
                         .target(GitHub.class, "https://api.github.com");

    github.contributors("OpenFeign", "feign");
    // метрики будут доступны с этого момента
  }
}

public class MyApp {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                         .addCapability(new Metrics5Capability())
                         .target(GitHub.class, "https://api.github.com");

    github.contributors("OpenFeign", "feign");
    // метрики будут доступны с этого момента
  }
}

public class MyApp {
  public static void main(String[] args) {
    GitHub github = Feign.builder()
                         .addCapability(new MicrometerCapability())
                         .target(GitHub.class, "https://api.github.com");

    github.contributors("OpenFeign", "feign");
    // метрики будут доступны с этого момента
  }
}

interface GitHub {
  @RequestLine("GET /repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo);

  @RequestLine("GET /users/{username}/repos?sort={sort}")
  List<Repo> repos(@Param("username") String owner, @Param("sort") String sort);
}
``````markdown
### Асинхронное выполнение через `CompletableFuture`

Feign 10.8 вводит новый построитель `AsyncFeign`, который позволяет методам возвращать экземпляры `CompletableFuture`.

```java
interface GitHub {
  @RequestLine("GET /repos/{owner}/{repo}/contributors")
  CompletableFuture<List<Contributor>> contributors(@Param("owner") String owner, @Param("repo") String repo);
}

public class MyApp {
  public static void main(String... args) {
    GitHub github = AsyncFeign.builder()
                               .decoder(new GsonDecoder())
                               .target(GitHub.class, "https://api.github.com");

    // Получение и вывод списка вкладчиков этого библиотеки.
    CompletableFuture<List<Contributor>> contributors = github.contributors("OpenFeign", "feign");
    for (Contributor contributor : contributors.get(1, TimeUnit.SECONDS)) {
      System.out.println(contributor.login + " (" + contributor.contributions + ")");
    }
  }
}

[Здесь](https://repo1.maven.org/maven2/io/github/openfeign/feign-bom/11.9/feign-bom-11.9.pom) можно посмотреть пример того, как выглядит файл BOM Feign.

#### Использование

```xml
<project>

...

  <dependencyManagement>
    <dependencies>
      <dependency>
        <groupId>io.github.openfeign</groupId>
        <artifactId>feign-bom</artifactId>
        <version>??feign.version??</version>
        <type>pom</type>
        <scope>import</scope>
      </dependency>
    </dependencies>
  </dependencyManagement>
</project>

<dependencies>
  ...
  <dependency>
    <groupId>io.github.openfeign.form</groupId>
    <artifactId>feign-form</artifactId>
    <version>4.0.0</version>
  </dependency>
  ...
</dependencies>

compile 'io.github.openfeign.form:feign-form:4.0.0'

SomeApi github = Feign.builder()
                       .encoder(new FormEncoder())
                       .target(SomeApi.class, "http://api.some.org");

SomeApi github = Feign.builder()
                       .encoder(new FormEncoder(new JacksonEncoder()))
                       .target(SomeApi.class, "http://api.some.org");

interface SomeApi {

  @RequestLine("POST /json")
  @Headers("Content-Type: application/json")
  void json(Dto dto);
}
```  @RequestLine("POST /form")
  @Headers("Content-Type: application/x-www-form-urlencoded")
  void from (@Param("field1") String field1, @Param("field2") String[] values);
}
```Вы можете указать два типа формата кодирования с помощью заголовка `Content-Type`.### application/x-www-form-urlencoded

```java
interface SomeApi {

  @RequestLine("POST /authorization")
  @Headers("Content-Type: application/x-www-form-urlencoded")
  void authorization (@Param("email") String email, @Param("password") String password);

  // Группировка всех параметров в POJO
  @RequestLine("POST /user")
  @Headers("Content-Type: application/x-www-form-urlencoded")
  void addUser (User user);

  class User {

    Integer id;

    String name;
  }
}

interface SomeApi {

  // Параметр файла
  @RequestLine("POST /send_photo")
  @Headers("Content-Type: multipart/form-data")
  void sendPhoto (@Param("is_public") Boolean isPublic, @Param("photo") File photo);

  // Параметр byte[]
  @RequestLine("POST /send_photo")
  @Headers("Content-Type: multipart/form-data")
  void sendPhoto (@Param("is_public") Boolean isPublic, @Param("photo") byte[] photo);

  // Параметр FormData
  @RequestLine("POST /send_photo")
  @Headers("Content-Type: multipart/form-data")
  void sendPhoto (@Param("is_public") Boolean isPublic, @Param("photo") FormData photo);

  // Группировка всех параметров в POJO
  @RequestLine("POST /send_photo")
  @Headers("Content-Type: multipart/form-data")
  void sendPhoto (MyPojo pojo);

  class MyPojo {

    @FormProperty("is_public")
    Boolean isPublic;

    File photo;
  }
}

### Поддержка Spring MultipartFile и Spring Cloud Netflix @FeignClient

Вы также можете использовать Form Encoder с Spring `MultipartFile` и `@FeignClient`.

Добавьте зависимости в файл `pom.xml` вашего проекта:
```xml
<dependencies>
  <dependency>
    <groupId>io.github.openfeign.form</groupId>
    <artifactId>feign-form</artifactId>
    <version>4.0.0</version>
  </dependency>
  <dependency>
    <groupId>io.github.openfeign.form</groupId>
    <artifactId>feign-form-spring</artifactId>
    <version>4.0.0</version>
  </dependency>
</dependencies>

@FeignClient(
    name = "file-upload-service",
    configuration = FileUploadServiceClient.MultipartSupportConfig.class
)
public interface FileUploadServiceClient extends IFileUploadServiceClient {

  public class MultipartSupportConfig {

    @Autowired
    private ObjectFactory<HttpMessageConverters> messageConverters;

    @Bean
    public Encoder feignFormEncoder () {
      return new SpringFormEncoder(new SpringEncoder(messageConverters));
    }
  }
}

@FeignClient(
    name = "file-upload-service",
    configuration = FileUploadServiceClient.MultipartSupportConfig.class
)
public interface FileUploadServiceClient extends IFileUploadServiceClient {

  public class MultipartSupportConfig {

    @Bean
    public Encoder feignFormEncoder () {
      return new SpringFormEncoder();
    }
  }
}

@FeignClient(
    name = "${feign.name}",
    url = "${feign.url}",
    configuration = DownloadClient.ClientConfiguration.class
)
public interface DownloadClient {

  @RequestMapping("/multipart/download/{fileId}")
  MultipartFile[] download(@PathVariable("fileId") String fileId);

  class ClientConfiguration {

    @Autowired
    private ObjectFactory<HttpMessageConverters> messageConverters;

    @Bean
    public Decoder feignDecoder () {
      List<HttpMessageConverter<?>> springConverters =
            messageConverters.getObject().getConverters();

      List<HttpMessageConverter<?>> decoderConverters =
            new ArrayList<HttpMessageConverter<?>>(springConverters.size() + 1);
      
      decoderConverters.addAll(springConverters);
      decoderConverters.add(new SpringManyMultipartFilesReader(4096));

      HttpMessageConverters httpMessageConverters = new HttpMessageConverters(decoderConverters);

      return new SpringDecoder(new ObjectFactory<HttpMessageConverters>() {

        @Override
        public HttpMessageConverters getObject() {
          return httpMessageConverters;
        }
      });
    }
  }
}
```