{title:'HTTP Part Annotations', updated:'8.1.0,9.0.0'}

The following annotations allow for defining part schemas based on the OpenAPI standard.

- Request annotations:
  - {@link oaj.http.annotation.Request}
    - {@link oaj.http.annotation.Request#on() on}
    - {@link oaj.http.annotation.Request#onClass() onClass}
    - {@link oaj.http.annotation.Request#parser() parser}
  - {@link oaj.http.annotation.Header}
    - {@link oaj.http.annotation.Header#name() name}
    - {@link oaj.http.annotation.Header#parser() parser}
    - {@link oaj.http.annotation.Header#schema() schema}
    - {@link oaj.http.annotation.Header#value() value}
  - {@link oaj.http.annotation.Query}
    - {@link oaj.http.annotation.Query#name() name}
    - {@link oaj.http.annotation.Query#parser() parser}
    - {@link oaj.http.annotation.Query#schema() schema}
    - {@link oaj.http.annotation.Query#value() value}
  - {@link oaj.http.annotation.FormData}
    - {@link oaj.http.annotation.FormData#name() name}
    - {@link oaj.http.annotation.FormData#parser() parser}
    - {@link oaj.http.annotation.FormData#schema() schema}
    - {@link oaj.http.annotation.FormData#value() value}
  - {@link oaj.http.annotation.Path}
    - {@link oaj.http.annotation.Path#name() name}
    - {@link oaj.http.annotation.Path#parser() parser}
    - {@link oaj.http.annotation.Path#schema() schema}
    - {@link oaj.http.annotation.Path#value() value}
  - {@link oaj.http.annotation.Content}
    - {@link oaj.http.annotation.Content#schema() schema}
- Response annotations:
  - {@link oaj.http.annotation.Response}
    - {@link oaj.http.annotation.Response#examples() examples}
    - {@link oaj.http.annotation.Response#headers() headers}
    - {@link oaj.http.annotation.Response#on() on}
    - {@link oaj.http.annotation.Response#onClass() onClass}
    - {@link oaj.http.annotation.Response#schema() schema}
    - {@link oaj.http.annotation.Response#serializer() serializer}
  - {@link oaj.http.annotation.Header}
    - {@link oaj.http.annotation.Header#name() name}
    - {@link oaj.http.annotation.Header#schema() schema}
    - {@link oaj.http.annotation.Header#serializer() serializer}
    - {@link oaj.http.annotation.Header#value() value}
  - {@link oaj.http.annotation.Content}
    - {@link oaj.http.annotation.Content#schema() schema}
  - {@link oaj.http.annotation.StatusCode}
    - {@link oaj.http.annotation.StatusCode#value() value}
- Common schema annotation:
  - {@link oaj.http.annotation.Schema}
    - {@link oaj.http.annotation.Schema#_default() _default}
    - {@link oaj.http.annotation.Schema#_enum() _enum}
    - {@link oaj.http.annotation.Schema#$ref() $ref}
    - {@link oaj.http.annotation.Schema#additionalProperties() additionalProperties}
    - {@link oaj.http.annotation.Schema#aev() aev}
    - {@link oaj.http.annotation.Schema#allOf() allOf}
    - {@link oaj.http.annotation.Schema#allowEmptyValue() allowEmptyValue}
    - {@link oaj.http.annotation.Schema#cf() cf}
    - {@link oaj.http.annotation.Schema#collectionFormat() collectionFormat}
    - {@link oaj.http.annotation.Schema#d() d}
    - {@link oaj.http.annotation.Schema#description() description}
    - {@link oaj.http.annotation.Schema#df() df}
    - {@link oaj.http.annotation.Schema#discriminator() discriminator}
    - {@link oaj.http.annotation.Schema#e() e}
    - {@link oaj.http.annotation.Schema#emax() emax}
    - {@link oaj.http.annotation.Schema#emin() emin}
    - {@link oaj.http.annotation.Schema#exclusiveMaximum() exclusiveMaximum}
    - {@link oaj.http.annotation.Schema#exclusiveMinimum() exclusiveMinimum}
    - {@link oaj.http.annotation.Schema#externalDocs() externalDocs}
    - {@link oaj.http.annotation.Schema#f() f}
    - {@link oaj.http.annotation.Schema#format() format}
    - {@link oaj.http.annotation.Schema#ignore() ignore}
    - {@link oaj.http.annotation.Schema#items() items}
    - {@link oaj.http.annotation.Schema#max() max}
    - {@link oaj.http.annotation.Schema#maxi() maxi}
    - {@link oaj.http.annotation.Schema#maximum() maximum}
    - {@link oaj.http.annotation.Schema#maxItems() maxItems}
    - {@link oaj.http.annotation.Schema#maxl() maxl}
    - {@link oaj.http.annotation.Schema#maxLength() maxLength}
    - {@link oaj.http.annotation.Schema#maxp() maxp}
    - {@link oaj.http.annotation.Schema#maxProperties() maxProperties}
    - {@link oaj.http.annotation.Schema#min() min}
    - {@link oaj.http.annotation.Schema#mini() mini}
    - {@link oaj.http.annotation.Schema#minimum() minimum}
    - {@link oaj.http.annotation.Schema#minItems() minItems}
    - {@link oaj.http.annotation.Schema#minl() minl}
    - {@link oaj.http.annotation.Schema#minLength() minLength}
    - {@link oaj.http.annotation.Schema#minp() minp}
    - {@link oaj.http.annotation.Schema#minProperties() minProperties}
    - {@link oaj.http.annotation.Schema#mo() mo}
    - {@link oaj.http.annotation.Schema#multipleOf() multipleOf}
    - {@link oaj.http.annotation.Schema#on() on}
    - {@link oaj.http.annotation.Schema#onClass() onClass}
    - {@link oaj.http.annotation.Schema#p() p}
    - {@link oaj.http.annotation.Schema#pattern() pattern}
    - {@link oaj.http.annotation.Schema#properties() properties}
    - {@link oaj.http.annotation.Schema#r() r}
    - {@link oaj.http.annotation.Schema#readOnly() readOnly}
    - {@link oaj.http.annotation.Schema#required() required}
    - {@link oaj.http.annotation.Schema#ro() ro}
    - {@link oaj.http.annotation.Schema#sie() sie}
    - {@link oaj.http.annotation.Schema#skipIfEmpty() v}
    - {@link oaj.http.annotation.Schema#t() t}
    - {@link oaj.http.annotation.Schema#title() title}
    - {@link oaj.http.annotation.Schema#type() type}
    - {@link oaj.http.annotation.Schema#ui() ui}
    - {@link oaj.http.annotation.Schema#uniqueItems() uniqueItems}
    - {@link oaj.http.annotation.Schema#xml() xml}

The {@link oaj.http.annotation.Header @Header}/{@link oaj.http.annotation.Query @Query}/ {@link oaj.http.annotation.FormData @FormData}/{@link oaj.http.annotation.Path @Path} annotations can be used on parameters of {@link oajr.annotation.RestOp @RestOp}-annotated methods to get access to request headers, query parameters, form-data parameters, and path parts.

The most typical scenario is to simply use the value field to define parameter names:

##### Example:

| @RestGet | public void doGet( | @Query("p1") int p1, | @Query("p2") String p2, | @Query("p3") UUID p3) {...}

This is functionally equivalent to the following code:

| @RestGet | public void doGet(RestRequest req) { | RequestQueryParams query = req.getQueryParams(); | int p1 = query.get("p1").asInteger().orElse(0); | String p2 = query.get("p2").orElse(null); | UUID p3 = query.get("p3").as(UUID.class).orElse(null); | }

The special name "*" (or blank) can be used to represent all values. When used, the data type must be a Map or bean.

##### Examples:

| // Multiple values passed as a map. | @RestGet | public void doGet(@Query("*") Map<String,Object> map) {...}

| // Same, but name "*" is inferred. | @RestGet | public void doGet(@Query Map<String,Object> map) {...}

| // Multiple values passed as a bean. | @RestGet | public void doGet(@Query MyQueryBean bean) {...}

The {@link oaj.http.annotation.Content @Content} annotation is used to identify POJOs to be used as the body of an HTTP request.

##### Examples:

| // Defined on parameter | @RestPost | public void addPet(@Content Pet pet) {...}

| // Defined on POJO class | @RestPost | public void addPet(Pet pet) {...} | | @Content | public class Pet {...}

This is functionally equivalent to the following code:

| @RestPost | public void addPet(RestRequest req) { | Pet pet = req.getContent().as(Pet.class); | ... | }

In addition to {@link oaj.http.annotation.Content @Content}-annotated parameters/types, the body of an HTTP request can be retrieved by passing in parameters of the following types (matched in the specified order):

1. {@link java.io.Reader}
   @Content annotation is optional.
   Content-Type is ignored.
2. {@link java.io.InputStream}
   @Content annotation is optional.
   Content-Type is ignored.
3. Any {@doc jm.PojoCategories Parsable POJO} type.
   Content-Type is required to identify correct parser.
4. Objects convertible from {@link java.io.Reader} by having one of the following non-deprecated methods:
   - public T(Reader in) {...}
   - public static T create(Reader in) {...}
   - public static T fromReader(Reader in) {...}
   Content-Type must not be present or match an existing parser so that it's not parsed as a POJO.
5. Objects convertible from {@link java.io.InputStream} by having one of the following non-deprecated methods:
   - public T(InputStream in) {...}
   - public static T create(InputStream in) {...}
   - public static T fromInputStream(InputStream in) {...}
   Content-Type must not be present or match an existing parser so that it's not parsed as a POJO.
6. Objects convertible from {@link java.lang.String} by having one of the following non-deprecated methods:
   - public T(String in) {...}
   - public static T create(String in) {...}
   - public static T fromString(String in) {...}
   - public static T parse(String in) {...}
   - public static T parseString(String in) {...}
   - public static T forName(String in) {...}
   - public static T forString(String in) {...}
   Note that this also includes all enums.
7. Any {@link java.util.Optional} of anything on this list.

When used in combination with the mutable {@link oaj.Value} object, the {@link oaj.http.annotation.StatusCode @StatusCode} and {@link oaj.http.annotation.Header @Header} annotations can be used on parameters {@link oajr.annotation.RestOp @RestOp}-annotated methods to to define to response codes and headers.

##### Example:

| @RestGet("/user/login") | public void login( | @FormData("username") String username, | @FormData("password") String password, | @StatusCode Value<Integer> status, | @Header("My-Response-Header") Value<String> myResponseHeader | ) { | if (isValid(username, password)) { | status.set(200); | myResponseHeader.set("Welcome " + username + "!"); | } else { | status.set(401); | } | }

This is functionally equivalent to the following code:

| @RestGet("/user/login") | public void doGet(RestRequest req, RestResponse res) { | RequestFormParams form = req.getFormParams(); | String username = form.get("username").orElse(null); | String password = form.get("password").orElse(null); | if (isValid(username, password) { | res.setStatus(200); | res.setHeader("My-Response-Header", "Welcome " + username + "!"); | } else { | res.setStatus(401); | } | }

The default registered part marshallers, {@link oaj.oapi.OpenApiSerializer} and {@link oaj.oapi.OpenApiParser}, are used to marshall POJOs using schemas defined via the {@link oaj.http.annotation.Schema @Schema} annotation.

For example, the following shows how a pipe-delimited list of comma-delimited numbers (e.g. "1,2,3|4,5,6|7,8,9") can be converted to a 2-dimensional array of Longs:

| @RestGet("/testQuery1") | public void testQuery1( | @Query("queryParamName") | @Schema( | collectionFormat="pipes", | items=@Items( | collectionFormat="csv", | type="integer", | format="int64", | minimum="0", | maximum="100" | minLength=1, | maxLength=10 | ), | minLength=1, | maxLength=10 | ) | Long[][] queryParameter | ) {...} | | // Same but using condensed notation. | @RestGet("/testQuery2") | public void testQuery2( | @Query("queryParamName") | @Schema( | cf="pipes", minl=1, maxl=10, | i=@Items(cf="csv", t="integer", f="int64", min="0", max="100", minl=1, maxl=10) | ) | Long[][] queryParameter | ) {...}

Schema-based marshalling works for both request and response parts. Input will be converted based on the types and formats defined in the schema definition. Input validations such as minLength/maxLength that don't match the input will result in automatic 400 Bad Request responses.

The part and schema annotations are also used for supplying swagger information about the HTTP part. This information is used to populate the auto-generated Swagger documentation and UI.

##### Example:

| @Query("name") | @Schema( | description="Pet name", | required=true | )

{@doc jrs.SvlVariables SVL Variables} (e.g. "$L{my.localized.variable}") are supported on annotation fields as well. Among other things, this allow for annotation values to be defined externally and the ability to produce localized swagger documents based on the Accept-Language on a request.

##### Example:

| @Schema( | description="$L{PetNameDescription}" | )

The {@link oaj.http.annotation.Content @Content} annotation can also be used to parse HTTP request bodies using OpenAPI schemas when the body content type matches the {@link oaj.oapi.OpenApiParser} parser via the header Content-Type: text/openapi.

The following shows the same for a request body:

| @RestPost("/testContent") | public void testContent( | @Content | @Schema( | items=@Items( | collectionFormat="pipes", | items=@SubItems( | collectionFormat="csv", | type="integer", | format="int64", | minimum="0", | maximum="100" | minLength=1, | maxLength=10 | ) | ), | minLength=1, | maxLength=10 | ) | Long[][] content | ) {...}

The list of valid POJO types for parameters depends on type and format of the value or items/entries of the value. For example, instead of Longs in the example above, we could also define a 2-dimensional array of POJOs convertible from Longs:

| // Content is a 2-dimensional array of POJOs convertible from Longs: | @RestPost("/example1") | public void testContent(@Content(...) MyPojo1[][] content) {...} | | public class MyPojo1 { | public MyPojo1(Long input) {...} | }

| // Content is a POJO that takes in a Long array: | @RestPost("/example2") | public void testContent(@Content(...) MyPojo2[] content) {...} | | public class MyPojo2 { | public MyPojo2(Long[] input) {...} | }

| // Content is a POJO that takes in the whole 2-dimensional array: | @RestPost("/example3") | public voidtestContent@Content(...) MyPojo3 content) {...} | | public class MyPojo3 { | public MyPojo3(Long[][] input) {...} | }

As you can see, the complexity of possible input types expands significantly. For more information about valid parameter types, see {@doc jm.OpenApiParsers OpenAPI Parsers}