Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Latest commit

 

History

History
155 lines (132 loc) · 8.45 KB

File metadata and controls

155 lines (132 loc) · 8.45 KB

FakeinlinecompositionPost

public class FakeinlinecompositionPost

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 Post
The class that has a post method to call the endpoint
interface InlineCompositionOperation
The interface that has a inlineComposition method to call the endpoint
static class PostRequest
The request inputs class
static class PostRequestBuilder
A builder for the request input class

Post

public static class Post extends ApiClient.ApiClient1 implements PostOperation

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

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.fakeinlinecomposition.post.FakeinlinecompositionPostRequestBody;
import org.openapijsonschematools.client.paths.fakeinlinecomposition.post.requestbody.content.applicationjson.ApplicationjsonSchema;
import org.openapijsonschematools.client.paths.fakeinlinecomposition.post.FakeinlinecompositionPostQueryParameters;
import org.openapijsonschematools.client.RootServerInfo;
import org.openapijsonschematools.client.servers.RootServer0;
import org.openapijsonschematools.client.servers.RootServer1;
import org.openapijsonschematools.client.servers.RootServer2;
import org.openapijsonschematools.client.paths.fakeinlinecomposition.post.responses.FakeinlinecompositionPostCode200Response;
import org.openapijsonschematools.client.servers.RootServerInfo;
import org.openapijsonschematools.client.paths.fakeinlinecomposition.FakeinlinecompositionPost;
import org.openapijsonschematools.client.paths.fakeinlinecomposition.post.FakeinlinecompositionPostResponses;

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());
FakeinlinecompositionPost.Post apiClient = new FakeinlinecompositionPost.Post(apiConfiguration, schemaConfiguration);


var request = new FakeinlinecompositionPost.PostRequestBuilder().build();

FakeinlinecompositionPostResponses.EndpointResponse response;
try {
    response = apiClient.post(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;
}
FakeinlinecompositionPostResponses.EndpointFakeinlinecompositionPostCode200Response castResponse = (FakeinlinecompositionPostResponses.EndpointFakeinlinecompositionPostCode200Response) response;
if (castResponse.body instanceof FakeinlinecompositionPostCode200Response.ApplicationjsonResponseBody deserializedBody) {
    // handle deserialized body here
} else {
    FakeinlinecompositionPostCode200Response.MultipartformdataResponseBody deserializedBody = (FakeinlinecompositionPostCode200Response.MultipartformdataResponseBody) castResponse.body;
    // handle deserialized body here
}

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
FakeinlinecompositionPostResponses.EndpointResponse post(PostRequest request)

InlineCompositionOperation

public interface InlineCompositionOperation

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

Method Summary

Modifier and Type Method and Description
FakeinlinecompositionPostResponses.EndpointResponse inlineComposition(PostRequest request)

PostRequest

public static class PostRequest

a class that stores the final request inputs

Field Summary

Modifier and Type Field and Description
FakeinlinecompositionPostRequestBody.@Nullable SealedRequestBody requestBody
optional
FakeinlinecompositionPostQueryParameters.@Nullable QueryParametersMap queryParameters
optional
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

PostRequestBuilder

public static class PostRequestBuilder

a builder for request inputs

Constructor Summary

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

Method Summary

Modifier and Type Method and Description
PostRequest build()
Returns the request input used to call an endpoint method
PostRequestBuilder requestBody(FakeinlinecompositionPostRequestBody.SealedRequestBody requestBody)
sets the optional property
PostRequestBuilder queryParameters(FakeinlinecompositionPostQueryParametersQueryParametersMap queryParameters)
sets the optional property
PostRequestBuilder serverIndex(RootServerInfo.ServerIndex serverIndex)
sets the optional property. Note: this will override the value in apiConfiguration
PostRequestBuilder timeout(Duration timeout)
sets the optional property. Note: this will override the value in apiConfiguration

[Back to top] [Back to README]