FooGet.md

FooGet

public class FooGet

A class that contains necessary endpoint classes

• a class that calls the endpoint method using the http verb
• a class that calls the endpoint method using the operationId name
• class(es) to store the request inputs
• builder(s) to set the request input data

Nested Class Summary

Modifier and Type	Class and Description
static class	Get The class that has a get method to call the endpoint
interface	FooGetOperation The interface that has a fooGet method to call the endpoint
static class	GetRequest The request inputs class
static class	GetRequestBuilder A builder for the request input class

Get

public static class Get extends ApiClient.ApiClient1 implements GetOperation

a class that allows one to call the endpoint using a method named get

Code Sample

import org.openapijsonschematools.client.configurations.ApiConfiguration;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.exceptions.NotImplementedException;
import org.openapijsonschematools.client.exceptions.ApiException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;
import org.openapijsonschematools.client.paths.foo.get.FooGetServerInfo;
import org.openapijsonschematools.client.paths.foo.get.servers.FooGetServer0;
import org.openapijsonschematools.client.paths.foo.get.servers.FooGetServer1;
import org.openapijsonschematools.client.paths.foo.get.responses.FooGetCodedefaultResponse;
import org.openapijsonschematools.client.paths.foo.get.FooGetServerInfo;
import org.openapijsonschematools.client.paths.foo.FooGet;
import org.openapijsonschematools.client.paths.foo.get.FooGetResponses;

import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.AbstractMap;

// if you want to use a server that is not SERVER_0 pass it in here and change the ServerIndex input below
ApiConfiguration.ServerInfo serverInfo = new ApiConfiguration.ServerInfoBuilder()
    .fooGetServerInfo(
        new FooGetServerInfo.FooGetServerInfoBuilder()
            .fooGetServer0(new FooGetServer0())
            .build()
    )
    .build();
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfoBuilder()
    .fooGetServerInfoServerIndex(FooGetServerInfo.ServerIndex.SERVER_0)
    .build();
Duration timeout = Duration.ofSeconds(1L);
Map<String, List<String>> defaultHeaders = Map.of("User-Agent", List.of("OpenAPI-JSON-Schema-Generator/1.0.0/java"));
ApiConfiguration apiConfiguration = new ApiConfiguration(
    serverInfo
    serverIndexInfo,
    timeout,
    defaultHeaders
);
SchemaConfiguration schemaConfiguration = new SchemaConfiguration(new JsonSchemaKeywordFlags.Builder().build());
FooGet.Get apiClient = new FooGet.Get(apiConfiguration, schemaConfiguration);


var request = new FooGet.GetRequestBuilder().build();

FooGetResponses.EndpointResponse response;
try {
    response = apiClient.get(request);
} catch (ApiException e) {
    // server returned a response/contentType not defined in the openapi document
    throw e;
} catch (ValidationException e) {
    // the returned response body or header values do not conform the the schema validation requirements
    throw e;
} catch (IOException | InterruptedException e) {
    // an exception happened when making the request
    throw e;
} catch (NotImplementedException e) {
    // the request body serialization or deserialization has not yet been implemented
    // or the header content type deserialization has not yet been implemented for this contentType
    throw e;
}
FooGetResponses.EndpointFooGetCodedefaultResponse castResponse = (FooGetResponses.EndpointFooGetCodedefaultResponse) response;
FooGetCodedefaultResponse.ApplicationjsonResponseBody deserializedBody = (FooGetCodedefaultResponse.ApplicationjsonResponseBody) castResponse.body;
// handle deserialized body here

Constructor Summary

Constructor and Description
Get(ApiConfiguration apiConfiguration, SchemaConfiguration schemaConfiguration) Creates an instance

Method Summary

Modifier and Type	Method and Description
FooGetResponses.EndpointResponse	get(GetRequest request)

FooGetOperation

public interface FooGetOperation

an interface that allows one to call the endpoint using a method named fooGet by the operationId

Method Summary

Modifier and Type	Method and Description
FooGetResponses.EndpointResponse	fooGet(GetRequest request)

GetRequest

public static class GetRequest

a class that stores the final request inputs

Field Summary

Modifier and Type	Field and Description
FooGetServerInfo.@Nullable ServerIndex	serverIndex optional. Note: this will override the value in apiConfiguration
@Nullable Duration	timeout optional. Note: this will override the value in apiConfiguration

GetRequestBuilder

public static class GetRequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
GetRequestBuilder() Creates a builder that contains null for all parameters

Method Summary

Modifier and Type	Method and Description
GetRequest	build() Returns the request input used to call an endpoint method
GetRequestBuilder	serverIndex(FooGetServerInfo.ServerIndex serverIndex) sets the optional property. Note: this will override the value in apiConfiguration
GetRequestBuilder	timeout(Duration timeout) sets the optional property. Note: this will override the value in apiConfiguration

[Back to top] [Back to README]