# Package org.eclipse.microprofile.rest.client.annotation

@Version("1.1.1") @ProviderType package org.eclipse.microprofile.rest.client.annotation
APIs for annotating MP Rest Client interfaces. Example:

     @RegisterProvider(MyMessageBodyReader.class)
     @RegisterProvider(MyMessageBodyWriter.class)
     @RegisterProvider(MyClientRequestFilter.class)
     public interface MyClientService {
         @GET
         @Path("/myService/{id}")
         Widget getWidget(@PathParam("id") String id);
     }

Related Packages
Package
Description
org.eclipse.microprofile.rest.client
APIs for building a type-safe RESTful client leveraging existing Jakarta RESTful Web Services APIs, for example:
org.eclipse.microprofile.rest.client.ext
APIs for extending MP Rest Client functionality - such as new providers.
org.eclipse.microprofile.rest.client.inject
APIs to aid in CDI-based injection of MP Rest Client implementations.
org.eclipse.microprofile.rest.client.spi
SPIs for MP Rest Client implementations or system-level components that provide additional functionality for MP Rest Clients.
Annotation Types
Class
Description
ClientHeaderParam
Used to specify an HTTP parameter that should be sent with the outbound request.
ClientHeaderParams
Used to specify HTTP parameters that should be sent with the outbound request.
RegisterClientHeaders
Used to specify that a `ClientHeadersFactory` should be used to generate or propagate HTTP headers on the outbound request.
RegisterProvider
When annotation is placed at the interface level of a REST API definition, the providers listed will be registered upon proxying.
RegisterProviders
When annotation is placed at the interface level of a REST API definition, the providers listed will be registered upon proxying.