guardrail is a code generation tool, capable of reading from OpenAPI/Swagger specification files and generating both Scala and Java source code, targeting various libraries and frameworks listed here:
- Scala:
akka-httpandhttp4s, both backed bycirce, as well asdropwizardbacked byjackson - Java:
dropwizardandspring-mvc, both backed byjackson
| Plugins | versions | docs |
|---|---|---|
guardrail-dev/sbt-guardrail |
 |
docs |
guardrail-dev/guardrail-maven-plugin |
 |
docs |
guardrail-dev/guardrail-gradle-plugin |
guardrail-gradle-plugin |
Plugin Portal |
| CLI support | Latest | cs install guardrail, docs |
Check out the docs!
Compatible library versions are listed in COMPATIBILITY.md
guardrail is modularized, using sbt-version-policy to ensure binary compatibility between dependent modules.
The dependency chain and versions of published modules are listed below for reference:
| module | version | depends on |
|---|---|---|
| guardrail-core |  |
|
| guardrail-java-support |  |
core |
| guardrail-java-async-http |  |
java-support |
| guardrail-java-dropwizard |  |
java-support, java-async-http |
| guardrail-java-spring-mvc |  |
java-support |
| guardrail-scala-support |  |
core |
| guardrail-scala-akka-http |  |
scala-support |
| guardrail-scala-dropwizard |  |
scala-support |
| guardrail-scala-http4s |  |
scala-support |
| guardrail |  |
core, java-support, java-dropwizard, java-spring-mvc, java-async-http, scala-support, scala-akka-http, scala-dropwizard, scala-http4s |
| guardrail-cli |  |
guardrail |
CONTRIBUTING.md provides an overview of how the project is structured, expectations, and information around writing new integration tests.
The issue tracker also has tags for help wanted and good first issue.
We used to have a list of contributors here, but github's Contributors page is much more accurate. Thanks to those who contributed before the project was open sourced!