Module io.helidon.webclient.api
Package io.helidon.webclient.api
Annotation Interface RestClient.Endpoint
- Enclosing class:
RestClient
Definition of the rest client API. An implementation of this interface (MUST be an interface) can
be injected when using Helidon Injection.
In case key
Configuration options for rest clients (prefixed by configKey()
:
Key | Default Value | Description |
---|---|---|
uri |
URI of this service | |
client |
Client configuration, see Proxy (Base URI will always be overridden by the uri defined on this level) |
client
node exists under the configuration node of this API, a new client will be created for this
instance (this always wins).
In case the clientName()
is defined, and an instance of that name is available in registry, it will be used
for this instance.
Then we use an unnamed client instance from the registry (if any).
The last resort is to create a new client that would be used for this API.-
Required Element Summary
Required Elements -
Optional Element Summary
Optional ElementsModifier and TypeOptional ElementDescriptionName of a named instance ofWebClient
we attempt to get from registry.Configuration key base to use when looking up options for the generated client.
-
Element Details
-
value
String valueThe URI of this API.Note that
Http.Path
annotation on the API (or its super interface) is added to this value.- Returns:
- endpoint URI of the generated client
-
configKey
String configKeyConfiguration key base to use when looking up options for the generated client.- Returns:
- configuration key prefix
- Default:
""
-
clientName
String clientNameName of a named instance ofWebClient
we attempt to get from registry.- Returns:
- client name
- Default:
""
-