OpenAPI Details

Juneau supports converting arbitrary POJOs to and from strings using OpenAPI-based schema rules.

The relevant classes for using OpenAPI-based serialization are:

- {@link oaj.oapi.OpenApiSerializer} - Converts POJOs to strings.
- {@link oaj.oapi.OpenApiParser} - Converts strings to POJOs.
- {@link oaj.httppart.HttpPartSchema} - Defines the schema for your POJO.

The {@link oaj.httppart.HttpPartSchema} class is used to define the formatting and validations for a POJO. It's used in conjunction with the serializer and parser to produce and consume HTTP parts based on OpenAPI rules.

Later in the rest-server and rest-client sections, we also describe how the following annotations can be applied to method parameters and class types to define the schema for various HTTP parts:

- {@link oaj.http.annotation.Body Body}
- {@link oaj.http.annotation.Header Header}
- {@link oaj.http.annotation.Query Query}
- {@link oaj.http.annotation.FormData FormData}
- {@link oaj.http.annotation.Path Path}
- {@link oaj.http.annotation.Response Response}
- {@link oaj.http.annotation.ResponseHeader ResponseHeader}