Package io.micronaut.http.client.annotation

Annotation Type Client

  • @Documented
@Retention(RUNTIME)
@Introduction
@Type(HttpClientIntroductionAdvice.class)
@Recoverable
@Singleton
public @interface Client
    Allows defining declarative HTTP clients and customizing injection for injecting HttpClient implementations.
    Since:
    1.0

    • Optional Element Summary

      Optional Elements 
      Modifier and Type Optional Element Description
      java.lang.Class<? extends HttpClientConfiguration> configuration  
      java.lang.Class<?> errorType  
      io.micronaut.http.HttpVersion httpVersion
      The HTTP version.
      java.lang.String id  
      java.lang.String path
      The base URI for the client.
      java.lang.String value  

    • Element Detail

      • value

        @AliasFor(member="id")
java.lang.String value
        Returns:
        The URL or service ID of the remote service
        Default:
        ""

      • id

        @AliasFor(member="value")
java.lang.String id
        Returns:
        The ID of the client
        Default:
        ""

      • path

        java.lang.String path
        The base URI for the client. Only to be used in conjunction with id().
        Returns:
        The base URI
        Default:
        ""

      • errorType

        java.lang.Class<?> errorType
        Returns:
        The type used to decode errors
        Default:
        io.micronaut.http.hateoas.JsonError.class

      • configuration

        java.lang.Class<? extends HttpClientConfiguration> configuration
        Returns:
        The http client configuration bean to use
        Default:
        io.micronaut.http.client.HttpClientConfiguration.class

      • httpVersion

        io.micronaut.http.HttpVersion httpVersion
        The HTTP version.
        Returns:
        The HTTP version of the client.
        Default:
        io.micronaut.http.HttpVersion.HTTP_1_1