ApiResponseSchema.md

ApiResponseSchema

org.openapijsonschematools.client.components.schemas.ApiResponseSchema.java public class ApiResponseSchema

A class that contains necessary nested

• schema classes (which validate payloads), extends JsonSchema
• classes to store validated map payloads, extends FrozenMap
• classes to build inputs for map payloads

Nested Class Summary

Modifier and Type	Class and Description
static class	ApiResponseSchema.ApiResponseSchema1 schema class
static class	ApiResponseSchema.ApiResponseMapBuilder builder for Map payloads
static class	ApiResponseSchema.ApiResponseMap output class for Map payloads
static class	ApiResponseSchema.Message schema class
static class	ApiResponseSchema.Type schema class
static class	ApiResponseSchema.Code schema class

ApiResponseSchema1

public static class ApiResponseSchema1
extends JsonSchema

A schema class that validates payloads

Code Sample

import org.openapijsonschematools.client.configurations.JsonSchemaKeywordFlags;
import org.openapijsonschematools.client.configurations.SchemaConfiguration;
import org.openapijsonschematools.client.exceptions.ValidationException;
import org.openapijsonschematools.client.schemas.validation.MapUtils;
import org.openapijsonschematools.client.schemas.validation.FrozenList;
import org.openapijsonschematools.client.schemas.validation.FrozenMap;

import java.util.Arrays;
import java.util.List;
import java.util.AbstractMap;

static final SchemaConfiguration configuration = new SchemaConfiguration(JsonSchemaKeywordFlags.ofNone());

// Map validation
ApiResponseSchema.ApiResponseMap validatedPayload =
    ApiResponseSchema.ApiResponseSchema1.validate(
    new ApiResponseSchema.ApiResponseMapBuilder()
        .code(1)

        .type("a")

        .message("a")

    .build(),
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(Map.class)
Map<String, Class<? extends JsonSchema>>	properties = Map.ofEntries(     new PropertyEntry("code", Code.class)),     new PropertyEntry("type", Type.class)),     new PropertyEntry("message", Message.class)) )

Method Summary

Modifier and Type	Method and Description
ApiResponseMap	validate(Map<?, ?> arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

ApiResponseMapBuilder

public class ApiResponseMapBuilder
builder for Map<String, @Nullable Object>

A class that builds the Map input type

Constructor Summary

Constructor and Description
ApiResponseMapBuilder() Creates a builder that contains an empty map

Method Summary

Modifier and Type	Method and Description
Map<String, @Nullable Object>	build() Returns map input that should be used with Schema.validate
ApiResponseMapBuilder	code(int value)
ApiResponseMapBuilder	code(float value)
ApiResponseMapBuilder	type(String value)
ApiResponseMapBuilder	message(String value)
ApiResponseMapBuilder	additionalProperty(String key, Void value)
ApiResponseMapBuilder	additionalProperty(String key, boolean value)
ApiResponseMapBuilder	additionalProperty(String key, String value)
ApiResponseMapBuilder	additionalProperty(String key, int value)
ApiResponseMapBuilder	additionalProperty(String key, float value)
ApiResponseMapBuilder	additionalProperty(String key, long value)
ApiResponseMapBuilder	additionalProperty(String key, double value)
ApiResponseMapBuilder	additionalProperty(String key, List<?> value)
ApiResponseMapBuilder	additionalProperty(String key, Map<String, ?> value)

ApiResponseMap

public static class ApiResponseMap
extends FrozenMap<String, @Nullable Object>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static ApiResponseMap	of(Map<String, ? extends @Nullable Object> arg, SchemaConfiguration configuration)
Number	code() [optional] value must be a 32 bit integer
String	type() [optional]
String	message() [optional]
@Nullable Object	getAdditionalProperty(String name) provides type safety for additional properties

Message

public static class Message
extends StringJsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema
validate

Type

public static class Type
extends StringJsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.StringJsonSchema
validate

Code

public static class Code
extends Int32JsonSchema

A schema class that validates payloads

Methods Inherited from class org.openapijsonschematools.client.schemas.Int32JsonSchema
validate

[Back to top] [Back to Component Schemas] [Back to README]