Skip to content
This repository has been archived by the owner on Feb 16, 2023. It is now read-only.
Wade Pearce edited this page Nov 12, 2018 · 4 revisions

The DropWizard RAML library is designed to provide a toolbox of libraries that can be used to help generate and view RAML specifications for your DropWizard library.

These libraries are designed to allow documentation of your service via the use of JAX-RS, Jackson and custom annotations which will then be used to generate a RAML specification from source code.

Why Use Annotations?

While documentation-based annotations can bloat source a bit, a common issue with documenting services is that it is common for documentation to fall out of sync with the actual features and functionality of the code itself. This project is designed to help reduce that disassociation between source code and documentation.