Class DefaultApi

java.lang.Object

de.xima.fc.api.rest.pub.client.generic.api.DefaultApi

All Implemented Interfaces:

EndpointCategory

@Generated("de.xima.openapi.codegen.java_jaxrs.XimaJavaJaxrsGenerator")
public final class DefaultApi
extends Object
implements EndpointCategory

The API for making structured REST API calls to the "DefaultApi" endpoint.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
final class	DefaultApi.GetEntryPoint	Handler for the getEntryPoint API method that lets you choose the content type via the Accept header.

Constructor Summary

Constructors

Constructor	Description
DefaultApi(ApiClient apiClient)	Creates a new API handler that uses the given client to send the HTTP requests.

Method Summary

Modifier and Type	Method	Description
String	category()
DefaultApi.GetEntryPoint	getEntryPoint()	Lists all the entry points of the API Retrieves all the entry points of the API and is necessary for the HATEOAS constraint.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultApi

public DefaultApi(ApiClient apiClient)

Creates a new API handler that uses the given client to send the HTTP requests.

Parameters:

apiClient - The client to use for HTTP requests.

Method Details

category

public String category()

Specified by:

category in interface EndpointCategory

Returns:

The name of this category.

getEntryPoint

public DefaultApi.GetEntryPoint getEntryPoint()
                                       throws IllegalArgumentException

Lists all the entry points of the API Retrieves all the entry points of the API and is necessary for the HATEOAS constraint.

Returns:

A handler for making a call to the API with a given content type (accept header).

Throws:

IllegalArgumentException - When a required parameter is missing or a parameter does not confirm to the expected format.