Module io.avaje.http.api
Package io.avaje.http.api

Annotation Type Client

@Target(TYPE) @Retention(RUNTIME) public @interface Client
Marker annotation for client. 

 @Client
 interface CustomerApi {
   ...
   @Get("/{id}")
   Customer getById(long id);

   @Post
   long save(Customer customer);
 }

Client.Import

When the client interface already exists in another module we use Client.Import to generate the client.

Specify the @Client.Import on the package or class to refer to the client interface we want to generate. 


 @Client.Import(types = OtherApi.class)
 package org.example;

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static @interface 
    Client.Import
    Specify @Client.Import on a package or class to refer to the client interface we want to generate.

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    boolean
    generate
    Flag to set whether to generate a Client Implementation.

  • Element Details

    • generate

      boolean generate
      Flag to set whether to generate a Client Implementation. Set false if the interface exists merely to be extended by other client interfaces
      Default:
      true