Taking inspiration from the reference implementation of Jaxrs "Jersey", this implementation of Jaxrs for vertx is named "Vest".
A library that can be used to easily create routes with minimal code in vertx. This initial implementation will support creating REST services in vertx using jax-rs 2.0 (JSR339). The idea around this implementation is to create a framework on vertx, meaning that you would not be required to embed an implemenation such as Jersey, but rather leverage off the existing vertx platform.
- @Path (without regular expressions)
- @POST, @PUT, @GET, @DELETE, @OPTION and @HEAD
- @Context
- Application implementation in the form of VestApplication.
- @PathParam
- @HeaderParam
- @QueryParam
- @DefaultValue
- JsonObject as a parameter in a handler
- @Consumes (Alpha)
- @Produces (Alpha)
Check issues
The vestframework is an implementation of the JSR339 specification. It allows you to use the specification to develop Http REST services using vertx. The framework has the following 2 main components:
- RouteMatcherBuilder
- VestApplication
The VestApplication which is an abstract implementation of jaxrs Application that provides the RouteMatcherBuilder context for building a RouteMatcher from classes using the jaxrs annotations.
TODO
There are 3 steps to get up and running in the simplest case:
- Create an implementation of the VestApplication and annotate it with @ApplicationPath to set the context.
@ApplicationPath("/sample")
public class VertxApplication extends VestApplication {
}- Annotate your classes that handle http requests with the jaxrs annotations. Note the first parameter must always be the HttpServerRequest.
@Path("/entity")
public class EntityHandler extends VertxAwareHandler {
@GET
public void get(HttpServerRequest serverRequest) {
serverRequest.response.headers().put("Content-Type", "text/html; charset=UTF-8");
serverRequest.response.end("<html><body><h1>Hello from vest!</h1></body></html>");
}
}- Use the JaxrsRoute
Vertx vertx = Vertx.newVertx();
VestApplication application = new VertxApplication();
application.addPackagesToScan("<package to scan>");
HttpServer server = vertx.createHttpServer();
application.addSingleton(vertx);
RouteMatcherBuilder builder = new JaxrsRouteMatcherBuilder(application);
server.requestHandler(builder.build());
server.listen(18080);- Now navigate to http://localhost:18080/sample/entity
- Section 3.7 (Matching Requests to Resource Methods) will be ignored and matching requests will be delegated to the RouteMatcher.