sample spec for testing openapi functionality, built from json schema tests for draft2020-12

This Java package is automatically generated by the OpenAPI JSON Schema Generator project:

• OpenAPI document version: 0.0.1
• Java Package version: 0.0.1
• OpenAPI JSON Schema Generator, Generator: JavaClientGenerator

1. Java 17
2. Maven

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapijsonschematools</groupId>
  <artifactId>openapi-java-client</artifactId>
  <version>0.0.1</version>
  <scope>compile</scope>
</dependency>

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/openapi-java-client-0.0.1.jar
• target/lib/*.jar

This Java code validates data to schema classes and return back an immutable instance containing the data. This ensure that

• valid data cannot be mutated and become invalid to a set of schemas
  • the one exception is that files are not immutable, so schema instances storing/sending/receiving files are not immutable

Here is the mapping from json schema types to Java types:

In openapi v3.0.3 there are ~ 28 json schema keywords. Almost all of them can apply if type is unset. I have chosen to separate the storage of

• json schema definition info
• output classes for validated Map (json schema type object) payloads
• output classes for validated List (json schema type array) payloads

Most component schemas (models) are probably of type object. Which is a map data structure. Json schema allows string keys in this map, which means schema properties can have key names that are invalid Java variable names. Names like:

• "hi-there"
• "1variable"
• "@now"
• " "
• "from"

To allow these use cases to work, FrozenMap (which extends AbstractMap) is used as the base class of type object schemas. This means that one can use normal Map methods on instances of these classes.

N schemas can be validated on the same payload. To allow multiple schemas to validate, the data must be stored using one base class whether or not a json schema format constraint exists in the schema.

In json schema, type: number with no format validates both integers and floats, so int and float values are stored for type number.

- type: string

- type: string
  format: date

Please follow the installation procedure and then use the JsonSchema classes in org.openapijsonschematools.client.components.schemas to validate input payloads and instances of validated Map and List output classes. Json schemas allow multiple types for one schema, so a schema's validate method can have allowed input and output types.

All URIs are relative to the selected server

• The server is selected by passing in serverInfo + serverIndexInfo into configurations.ApiConfiguration
• The security info is selected by passing in securityInfo + securityIndexInfo into configurations.ApiConfiguration
• serverIndex + securityIndex can also be passed in to endpoint calls, see endpoint documentation