Interface ApiClient

  • All Superinterfaces:
    java.lang.AutoCloseable, java.io.Closeable, StubCreator

    public interface ApiClient
    extends StubCreator, java.io.Closeable
    Represents a Client for an API.

    Instances of implementing classes obtain and manage any resource needed to connect to the API provider, exchange request/response pairs and perform any other activities for consuming the remote API.

    This is a StubCreator which is the mechanism to create remote stubs for the API services.

    Use the static factory methods from ApiClients to create instances.

    The ApiClient instance must be Closeable.close() when it and the stubs it created are no longer needed. This will ensure that all resources used by this instances are freed.