src-openfeign/jaxrs2/README.md

# Feign JAXRS 2
This module overrides annotation processing to instead use standard ones supplied by the JAX-RS specification.  This is currently targeted at the 1.1 spec.

## Limitations
While it may appear possible to reuse the same interface across client and server, bear in mind that JAX-RS resource
 annotations were not designed to be processed by clients.  Moreover, JAX-RS 2.0 has a different package hierarchy for
client invocation.  Finally, JAX-RS is a large spec and attempts to implement it completely would be a project larger
than feign itself.  In other words, this implementation is *best efforts* and concedes far from 100% compatibility with
server interface behavior.

## Currently Supported Annotation Processing
Feign only supports processing java interfaces (not abstract or concrete classes).

ISE is raised when any annotation's value is empty or null.  Ex. `Path("")` raises an ISE.

Here are a list of behaviors currently supported.
### Type Annotations
#### `@Path`
Appends the value to `Target.url()`.  Can have tokens corresponding to `@PathParam` annotations.
### Method Annotations
#### `@HttpMethod` meta-annotation (present on `@GET`, `@POST`, etc.)
Sets the request method.
#### `@Path`
Appends the value to `Target.url()`.  Can have tokens corresponding to `@PathParam` annotations.
#### `@Produces`
Adds all values into the `Accept` header.
#### `@Consumes`
Adds the first value as the `Content-Type` header.
### Parameter Annotations
#### `@PathParam`
Links the value of the corresponding parameter to a template variable declared in the path.
#### `@QueryParam`
Links the value of the corresponding parameter to a query parameter.  When invoked, null will skip the query param.
#### `@HeaderParam`
Links the value of the corresponding parameter to a header.
#### `@FormParam`
Links the value of the corresponding parameter to a key passed to `Encoder.Text<Map<String, Object>>.encode()`.
#### `@BeanParm`
Aggregates the above supported parameter annotations under a single value object.
FIXED unsupported jaxrs-2.1 annotations should not break entire interface (#672) * FIXED unsupported jaxrs-2.1 annotations should not break entire interface, resolving #669 * UPDATED jaxrs: more defensive jaxrs2 support * ADDED jsr311-api dependency to httpclient (as jsr311 is `provided` in feign-jaxrs now) * UPDATED httpclient `jsr311-api` scope to test UPDATED jaxrs readme 7 years ago			`# Feign JAXRS 2`
			`This module overrides annotation processing to instead use standard ones supplied by the JAX-RS specification. This is currently targeted at the 1.1 spec.`

			`## Limitations`
			`While it may appear possible to reuse the same interface across client and server, bear in mind that JAX-RS resource`
			`annotations were not designed to be processed by clients. Moreover, JAX-RS 2.0 has a different package hierarchy for`
			`client invocation. Finally, JAX-RS is a large spec and attempts to implement it completely would be a project larger`
			`than feign itself. In other words, this implementation is best efforts and concedes far from 100% compatibility with`
			`server interface behavior.`

			`## Currently Supported Annotation Processing`
			`Feign only supports processing java interfaces (not abstract or concrete classes).`

			ISE is raised when any annotation's value is empty or null. Ex. `Path("")` raises an ISE.

			`Here are a list of behaviors currently supported.`
			`### Type Annotations`
			#### `@Path`
			Appends the value to `Target.url()`. Can have tokens corresponding to `@PathParam` annotations.
			`### Method Annotations`
			#### `@HttpMethod` meta-annotation (present on `@GET`, `@POST`, etc.)
			`Sets the request method.`
			#### `@Path`
			Appends the value to `Target.url()`. Can have tokens corresponding to `@PathParam` annotations.
			#### `@Produces`
fix #797 fix #798: JAXRSContract sets a single Content-Type value (#799) Closes #797 Closes #798 JAXRSContract sets a single Content-Type value This change allows headers to be cleared by passing a null value for backwards compatibility. Multiple Content-Type values are not valid because the body that we send with any given request will only have a single type. Updated header entry assertion to be agnostic to header name order. * RequestTemplate.headers clear behavior matches that of query params 6 years ago			Adds all values into the `Accept` header.
FIXED unsupported jaxrs-2.1 annotations should not break entire interface (#672) * FIXED unsupported jaxrs-2.1 annotations should not break entire interface, resolving #669 * UPDATED jaxrs: more defensive jaxrs2 support * ADDED jsr311-api dependency to httpclient (as jsr311 is `provided` in feign-jaxrs now) * UPDATED httpclient `jsr311-api` scope to test UPDATED jaxrs readme 7 years ago			#### `@Consumes`
			Adds the first value as the `Content-Type` header.
			`### Parameter Annotations`
			#### `@PathParam`
			`Links the value of the corresponding parameter to a template variable declared in the path.`
			#### `@QueryParam`
			`Links the value of the corresponding parameter to a query parameter. When invoked, null will skip the query param.`
			#### `@HeaderParam`
			`Links the value of the corresponding parameter to a header.`
			#### `@FormParam`
			Links the value of the corresponding parameter to a key passed to `Encoder.Text<Map<String, Object>>.encode()`.
Add Optional BeanParam support for JAXRS2Contract (#1935) * Add Optional BeanParam support for JAXRS2Contract * Fix Code Style * Commit Build Code Format Changes * Roll Back Removal of braces * Make sure jaxrs1 dependencies not avaiable on jaxrs2 * Update JAXRS2ContractWithBeanParamSupportTest.java * Always Use Enable BeanParam Support * Roll Back Test Changes --------- Co-authored-by: Marvin Froeder <velo@users.noreply.github.com> 2 years ago			#### `@BeanParm`
			`Aggregates the above supported parameter annotations under a single value object.`