View on GitHub RESTX     the lightweight Java REST framework

Welcome to RESTX!


RESTX is a brand new REST framework, we are happy you’re stopping by!

RESTX is still in its early infancy, but you can already get a taste of it…

Write this:

@Component @RestxResource
public class HelloResource {
    public Message sayHello(String who) {
        return new Message().setMessage(String.format(
                "hello %s, it's %s",


public class Message {
    private String message;

    public String getMessage() {  return message;  }

    public Message setMessage(final String message) {
        this.message = message;
        return this;

and that:

title: should say hello
  - time: 2013-03-31T14:33:18.272+02:00
  - when: GET message?who=xavier
    then: |
      {"message":"hello xavier, it's 14:33:18"}

and get that:

  • a server starting blazingly fast
22:22:33.015 [main             ] INFO  r.s.simple.simple.SimpleWebServer - starting web server
22:22:33.500 [main             ] INFO  o.h.validator.internal.util.Version - HV000001: Hibernate Validator 5.0.0.Final
22:22:33.605 [main             ] INFO  restx.RestxMainRouterFactory - 
 -- 2 filters
 -- 15 routes
 -- for admin console,
 --   VISIT http://localhost:8086/api/@/ui/
  • a working implementation of your REST endpoint
[restx] http "http://localhost:8086/api/message?who=xavier"                                                                                                                                                           22:24:25  ☁  master ☂ ✭
HTTP/1.1 200 OK
Cache-Control: no-cache
Connection: keep-alive
Content-Type: application/json; charset=UTF-8
Transfer-Encoding: chunked

    "message": "hello xavier, it's 22:25:00"
  • documentation of your API with examples inside… REST API documentation with RESTX example

  • … that you can try directly within the browser trying REST API with RESTX example

  • an automated integration test automated integration test with RESTX

  • an admin console with…

  • basic monitoring UI monitoring UI with RESTX

  • beans graph visualization monitoring UI with RESTX

  • and more…

comments powered by Disqus