Introduction to Guardrail
Guardrail is a robust code generation tool designed to streamline the development process by reading from OpenAPI/Swagger specification files. It efficiently generates both Scala and Java source code compatible with a variety of libraries and frameworks. This powerful tool enhances developer productivity by automating tedious coding tasks, allowing for faster and more efficient application development.
Supported Libraries and Frameworks
Guardrail supports a diverse range of libraries and frameworks across two major programming languages, Scala and Java, providing flexibility depending on developer preferences and project needs.
-
Scala:
akka-httphttp4s, both backed bycircedropwizardbacked byjackson
-
Java:
dropwizardspring-mvc, both supported byjackson
Build Tool Plugins
Guardrail can be seamlessly integrated into various build tools through a suite of plugins, simplifying the setup and configuration process:
- SBT Plugin:
guardrail-dev/sbt-guardrail - Maven Plugin:
guardrail-dev/guardrail-maven-plugin - Gradle Plugin:
guardrail-dev/guardrail-gradle-plugin - Command Line Interface Support: Offers straightforward installation and usage via the CLI.
New to Guardrail?
For those new to the world of Guardrail, a comprehensive set of documentation is available to help users get started and make the most of its capabilities. The docs provide detailed guidance on configuration, usage, and troubleshooting.
Modular Architecture
Guardrail is built upon a modular architecture to ensure binary compatibility and independent module updates. The modules and their respective dependencies are meticulously structured to optimize performance and compatibility, making Guardrail an efficient tool for modern software development.
Contributing to Guardrail
Guardrail thrives on community contribution and collaboration. Developers interested in contributing can refer to CONTRIBUTING.md for insights into project structure, code expectations, and testing strategies. The project's issue tracker is also the go-to resource for identifying areas where help is needed, including tags for help wanted and good first issue to assist new contributors.
Notable Adopters
Guardrail is trusted by renowned companies in the tech industry:
- Avast: Known for its powerful cybersecurity solutions.
- Twilio: A leader in cloud communications platforms.
With its wide adoption and continuous community contributions, Guardrail is setting new standards in software code generation, making it an invaluable tool in the developer’s toolkit.