Package reactivefeign.spring.config

Annotation Interface ReactiveFeignClient

@Target(TYPE) @Retention(RUNTIME) @Documented public @interface ReactiveFeignClient
Annotation for interfaces declaring that a REST client with that interface should be created (e.g. for autowiring into another component). patterned after org.springframework.cloud.netflix.feign.FeignClient

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>[]
    configuration
    A custom @Configuration for the feign client.
    boolean
    decode404
    Whether 404s should be decoded instead of throwing FeignExceptions
    Class<?>
    fallback
    Fallback class for the specified Feign client interface.
    Class<?>
    fallbackFactory
    Define a fallback factory for the specified Feign client interface.
    String
    name
    The service id with optional protocol prefix.
    String
    path
    Path prefix to be used by all method-level mappings.
    boolean
    primary
    Whether to mark the feign proxy as a primary bean.
    String
    qualifier
    Sets the @Qualifier value for the feign client.
    String
    url
    An absolute URL or resolvable hostname (the protocol is optional).
    String
    value
    The name of the service with optional protocol prefix.

  • Element Details

    • value

      @AliasFor("name") String value
      The name of the service with optional protocol prefix. Synonym for name. A name must be specified for all clients, whether or not a url is provided. Can be specified as property key, eg: ${propertyKey}.
      Default:
      ""

    • name

      @AliasFor("value") String name
      The service id with optional protocol prefix. Synonym for value.
      Default:
      ""

    • qualifier

      String qualifier
      Sets the @Qualifier value for the feign client.
      Default:
      ""

    • url

      String url
      An absolute URL or resolvable hostname (the protocol is optional).
      Default:
      ""

    • decode404

      boolean decode404
      Whether 404s should be decoded instead of throwing FeignExceptions
      Default:
      false

    • configuration

      Class<?>[] configuration
      A custom @Configuration for the feign client. Can contain override @Bean definition for the pieces that make up the client, for instance ReactiveHttpRequestInterceptor, Contract.
      See Also:
      Default:
      {}

    • fallback

      Class<?> fallback
      Fallback class for the specified Feign client interface. The fallback class must implement the interface annotated by this annotation and be a valid spring bean.
      Default:
      void.class

    • fallbackFactory

      Class<?> fallbackFactory
      Define a fallback factory for the specified Feign client interface. The fallback factory must produce instances of fallback classes that implement the interface annotated by ReactiveFeignClient. The fallback factory must be a valid spring bean.
      Default:
      void.class

    • path

      String path
      Path prefix to be used by all method-level mappings. Can be used with or without @RibbonClient.
      Default:
      ""

    • primary

      boolean primary
      Whether to mark the feign proxy as a primary bean. Defaults to true.
      Default:
      true