Skip to content

Latest commit

 

History

History
106 lines (71 loc) · 3.41 KB

README.md

File metadata and controls

106 lines (71 loc) · 3.41 KB
Raw

Java class conversion to OpenAPI 3 YAML Schema Object

This project consists of a Java application used for converting a Java class to a free-form object in OpenAPI 3 YAML Schema Object definition.

This implementation is an extension of the free-form query parameter definition in OpenAPI 3 specification.

The OpenAPI 3 YAML Schema Object is inserted into an OpenAPI 3 document, compliant with the YAML version 1.2 format.

The official OpenAPI 3 documentation is: OpenAPI 3.0.0 documentation

Development

Setup

Install OpenJDK 11.

Build project

gradlew clean build

Run project

java -jar build/libs/object-converter-0.0.2-SNAPSHOT.jar <Java-class-canonical-name>

Example:

java -jar build/libs/object-converter-0.0.2-SNAPSHOT.jar de.mcella.openapi.v3.objectconverter.Example

The generated OpenAPI 3 document is the file "build/libs/openapi.yaml".

Example with external class:

javac example-external\src\* -d example-external\classes

Windows:

java -cp build\libs\*;example-external\classes de.mcella.openapi.v3.objectconverter.ObjectConverterMain  de.mcella.openapi.v3.objectconverter.example.ExampleFromExternal

Linux and MacOS:

java -cp "build/libs/*:example-external/classes:." de.mcella.openapi.v3.objectconverter.ObjectConverterMain de.mcella.openapi.v3.objectconverter.example.ExampleFromExternal

The generated OpenAPI 3 document is a file named "build/libs/openapi.yaml".

OpenAPI 3 document validation

Run the following gradle command to validate the generated OpenAPI 3 document:

gradlew openApiValidate

Source code style

This project follows the Google Java Style, and uses the google-java-format formatter.

Documentation

This application is useful to convert a complex Java class to an OpenAPI 3 Schema free-form object definition.

The OpenAPI 3 YAML Schema Object is inserted into an OpenAPI 3 document. The generated OpenAPI 3 document is a single and complete OpenAPI 3 document with a simple template. The converted Java class is inserted as a Schema Object into a sample POST request with body content "application/json".

Assumptions:

  • The Schema Object does not contain Reference Objects
  • The Schema Object contains a subset of the available OpenAPI specification properties
  • The application does not support composition and inheritance using the "allOf" and "discriminator" properties

Data Types

The supported OpenAPI 3 data types are the following:

Common name type format Comments
integer integer int32 signed 32 bits
long integer int64 signed 64 bits
float number float
double number double
string string
byte string byte base64 encoded characters
boolean boolean
date string date As defined by full-date - RFC3339
dateTime string date-time As defined by date-time - RFC3339

The application supports both Java primitive types and Java wrapper classes.

Features

The application supports the conversion of:

  • Java primitive and Java wrapper classes
  • Custom classes
  • Lists (with a defined Generic Class)
  • Dictionaries