Java JavaScript Other
Latest commit 533ccc5 Feb 24, 2017 @feroult version bump
Failed to load latest commit information.
scripts yawp js folder, to add command line tools Sep 11, 2016
yawp-appengine version bump Feb 24, 2017
yawp-core version bump Feb 24, 2017
yawp-js fixtures options Jan 29, 2017
yawp-maven-plugin version bump Feb 24, 2017
yawp-postgresql version bump Feb 24, 2017
yawp-testing version bump Feb 24, 2017
.gitignore format code - intellij change Nov 17, 2015
.travis.yml client Jul 8, 2016
LICENSE added license Oct 25, 2015 Update Oct 21, 2016
pom.xml version bump Feb 24, 2017


A lightweight REST API framework focused on productivity and scalability.

Build Status Maven Central Join the chat at


Here you can find the complete YAWP! Guides.

Getting Started

  1. At the command prompt, create a new YAWP! API application:

    $ mvn archetype:generate \
        -DarchetypeGroupId=io.yawp \
        -DarchetypeArtifactId=yawp \
        -DarchetypeVersion=LATEST \
        -DgroupId=yawpapp \
        -DartifactId=yawpapp \
  2. Change directory to yawpapp and start the yawp development server:

    $ cd yawpapp
    $ mvn yawp:devserver
  3. Using a browser, go to http://localhost:8080/api to check if everything is OK.

  4. Using a scaffolder, create a simple endpoint model:

    $ mvn yawp:endpoint -Dmodel=person


    @Endpoint(path = "/people")
    public class Person {
        IdRef<Person> id;

    Try it:

    $ curl http://localhost:8080/api/people
  5. Follow the guidelines to start developing your API:


Everyone willing to contribute with YAWP! is welcome. To start developing you will need an environment with:

  • JDK 1.7+
  • Maven 3.3+
  • PostgreSQL 9.4+

Then follow the travis-ci build script to get your build working.


Feel free to contact the developers at the IRC channel #yawp at


YAWP! is released under the MIT license.