Skip to content

Latest commit

 

History

History
185 lines (154 loc) · 9.51 KB

File metadata and controls

185 lines (154 loc) · 9.51 KB

FakequeryparamwithjsoncontenttypeGet

public class FakequeryparamwithjsoncontenttypeGet

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 QueryParamWithJsonContentTypeOperation
The interface that has a queryParamWithJsonContentType method to call the endpoint
static class GetRequest
The final request inputs class
static class GetNullableRequest
The initial request inputs class
static class Get0RequestBuilder
A builder for the request input 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.RootServerInfo;
import org.openapijsonschematools.client.paths.fakequeryparamwithjsoncontenttype.get.FakequeryparamwithjsoncontenttypeGetQueryParameters;
import org.openapijsonschematools.client.servers.RootServer0;
import org.openapijsonschematools.client.servers.RootServer1;
import org.openapijsonschematools.client.servers.RootServer2;
import org.openapijsonschematools.client.paths.fakequeryparamwithjsoncontenttype.get.responses.FakequeryparamwithjsoncontenttypeGetCode200Response;
import org.openapijsonschematools.client.servers.RootServerInfo;
import org.openapijsonschematools.client.paths.fakequeryparamwithjsoncontenttype.FakequeryparamwithjsoncontenttypeGet;
import org.openapijsonschematools.client.paths.fakequeryparamwithjsoncontenttype.get.FakequeryparamwithjsoncontenttypeGetResponses;

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()
    .rootServerInfo(
        new RootServerInfo.RootServerInfoBuilder()
            .rootServer0(new RootServer0())
            .build()
    )
    .build();
ApiConfiguration.ServerIndexInfo serverIndexInfo = new ApiConfiguration.ServerIndexInfoBuilder()
    .rootServerInfoServerIndex(RootServerInfo.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());
FakequeryparamwithjsoncontenttypeGet.Get apiClient = new FakequeryparamwithjsoncontenttypeGet.Get(apiConfiguration, schemaConfiguration);


// Map validation
FakequeryparamwithjsoncontenttypeGetQueryParameters.QueryParametersMap queryParameters =
    FakequeryparamwithjsoncontenttypeGetQueryParameters.FakequeryparamwithjsoncontenttypeGetQueryParameters1.validate(
    new FakequeryparamwithjsoncontenttypeGetQueryParameters.QueryParametersMapBuilder()
    .build(),
    schemaConfiguration
);

var request = new FakequeryparamwithjsoncontenttypeGet.GetRequestBuilder()
    .queryParameters(queryParameters)
    .build();

FakequeryparamwithjsoncontenttypeGetResponses.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;
}
FakequeryparamwithjsoncontenttypeGetResponses.EndpointFakequeryparamwithjsoncontenttypeGetCode200Response castResponse = (FakequeryparamwithjsoncontenttypeGetResponses.EndpointFakequeryparamwithjsoncontenttypeGetCode200Response) response;
FakequeryparamwithjsoncontenttypeGetCode200Response.ApplicationjsonResponseBody deserializedBody = (FakequeryparamwithjsoncontenttypeGetCode200Response.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
FakequeryparamwithjsoncontenttypeGetResponses.EndpointResponse get(GetRequest request)

QueryParamWithJsonContentTypeOperation

public interface QueryParamWithJsonContentTypeOperation

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

Method Summary

Modifier and Type Method and Description
FakequeryparamwithjsoncontenttypeGetResponses.EndpointResponse queryParamWithJsonContentType(GetRequest request)

GetRequest

public static class GetRequest

a class that stores the final request inputs

Field Summary

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

GetNullableRequest

public static class GetNullableRequest

a class that stores the initial request inputs

Field Summary

Modifier and Type Field and Description
FakequeryparamwithjsoncontenttypeGetQueryParameters.@Nullable QueryParametersMap queryParameters
RootServerInfo.@Nullable ServerIndex serverIndex
@Nullable Duration timeout

Get0RequestBuilder

public static class Get0RequestBuilder

a builder for request inputs

Constructor Summary

Constructor and Description
Get0RequestBuilder(Get0RequestBuilder instance)
Creates a builder that contains the passed instance

Method Summary

Modifier and Type Method and Description
GetRequest build()
Returns the request input used to call an endpoint method
Get0RequestBuilder serverIndex(RootServerInfo.ServerIndex serverIndex)
sets the optional property. Note: this will override the value in apiConfiguration
Get0RequestBuilder timeout(Duration timeout)
sets the optional property. 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
Get0RequestBuilder queryParameters(FakequeryparamwithjsoncontenttypeGetQueryParametersQueryParametersMap queryParameters)
sets the property

[Back to top] [Back to README]