Server1.md

org.openapijsonschematools.client.servers.Server1

Server Server1

public class Server1

A class that stores a server url

Description

The local server

Constructor Summary

Constructor and Description
Server1() Creates a server using default values for variables
Server1(Variables.VariablesMap variables) Creates a server using input values for variables

Field Summary

Modifier and Type	Field and Description
String	url = "https://localhost:8080/{version}"
Variables.VariablesMap	variables

Variables

public class Variables

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
• enum classes

Nested Class Summary

Modifier and Type	Class and Description
static class	Variables.Variables1 schema class
static class	Variables.VariablesMapBuilder builder for Map payloads
static class	Variables.VariablesMap output class for Map payloads
static class	Variables.Version schema class
enum	Variables.StringVersionEnums String enum
static class	Variables.AdditionalProperties schema class

Variables1

public static class Variables1
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
Variables.VariablesMap validatedPayload =
    Variables.Variables1.validate(
    new Variables.VariablesMapBuilder()
        .version("v1")

    .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("version", Version.class)) )
Set	required = Set.of(     "version" )
Class<? extends JsonSchema>	additionalProperties = AdditionalProperties.class

Method Summary

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

VariablesMap0Builder

public class VariablesMap0Builder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

Constructor and Description
VariablesMap0Builder(Map<String, String> instance) Creates a builder that contains the passed instance

Method Summary

Modifier and Type	Method and Description
Map<String, String>	build() Returns map input that should be used with Schema.validate

VariablesMapBuilder

public class VariablesMapBuilder
builder for Map<String, String>

A class that builds the Map input type

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
VariablesMap0Builder	version(String value)
VariablesMap0Builder	version(StringVersionEnums value)

VariablesMap

public static class VariablesMap
extends FrozenMap<String, String>

A class to store validated Map payloads

Method Summary

Modifier and Type	Method and Description
static VariablesMap	of(Map<String, String> arg, SchemaConfiguration configuration)
String	version() must be one of ["v1", "v2"] if omitted the server will use the default value of v2

Version

public static class Version
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());

// String validation
String validatedPayload = Variables.Version.validate(
    "v1",
    configuration
);

Field Summary

Modifier and Type	Field and Description
Set<Class<?>>	type = Set.of(     String.class )
Set	enumValues = SetMaker.makeSet(     "v1",     "v2" )
@Nullable Object	defaultValue = "v2"

Method Summary

Modifier and Type	Method and Description
String	validate(String arg, SchemaConfiguration configuration)
String	validate(StringVersionEnums arg, SchemaConfiguration configuration)
@Nullable Object	validate(@Nullable Object arg, SchemaConfiguration configuration)

StringVersionEnums

public enum StringVersionEnums
extends Enum<StringVersionEnums>

A class that stores String enum values

Enum Constant Summary

Enum Constant	Description
V1	value = "v1"
V2	value = "v2"

AdditionalProperties

public static class AdditionalProperties
extends NotAnyTypeJsonSchema

A schema class that validates payloads

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

[Back to top] [Back to Servers] [Back to README]