Skip to content

JAX-RS

EasyApi supports JAX-RS (Java API for RESTful Web Services) frameworks including Quarkus and Jersey.

Supported Annotations

AnnotationDescription
@PathMaps a resource path
@GETMaps a GET request
@POSTMaps a POST request
@PUTMaps a PUT request
@DELETEMaps a DELETE request
@PATCHMaps a PATCH request
@HEADMaps a HEAD request
@OPTIONSMaps an OPTIONS request
@PathParamBinds a path parameter
@QueryParamBinds a query parameter
@FormParamBinds a form parameter
@HeaderParamBinds a header parameter
@CookieParamBinds a cookie parameter
@ConsumesSpecifies consumed media types
@ProducesSpecifies produced media types

Example

java
@Path("/users")
@Consumes(MediaType.APPLICATION_JSON)
@Produces(MediaType.APPLICATION_JSON)
public class UserResource {

    @GET
    @Path("/{id}")
    public User getUser(@PathParam("id") Long id) {
        // ...
    }

    @POST
    public User createUser(UserRequest request) {
        // ...
    }
}

Quarkus Support

Quarkus uses standard JAX-RS annotations, so EasyApi works out of the box with Quarkus applications. No additional configuration is needed.

Jersey Support

Jersey also uses standard JAX-RS annotations. EasyApi supports Jersey applications directly.

Released under the Apache-2.0 License.