atomicbits / scraml Edit

Generate typesafe Java and Scala REST API clients

Version Matrix

Type safe Java and Scala RAML client generator

Build Status

Scraml generates a typesafe Java or Scala client library based on a RAML specification. It transforms JSON schema into fully typed Java POJOs or Scala case classes and a REST resources DSL that enforces your RAML specification. We also support Typescript TO generation and HTML documentation generation. Plugins are available for maven, gradle and sbt.


Follow the steps in these quickstart guidelines:

  1. Java Quickstart
  2. Scala Quickstart

Release notes

Read here about the most recent releases

Enable code generation with scraml in your project with the scraml-maven-plugin, the scraml-gradle-plugin or the scraml-sbt-plugin. Have a look at the scraml-test-java, the scraml-test-java-gradle and the scraml-test-scala projects respectively for an example of how to enable scraml in you projects.

Copyright and License

Copyright 2018 Atomic BITS bvba. Code released under the Apache 2.0 License.