![Gitter](https://badges.gitter.im/Join Chat.svg)
This is a Java implementation of a RAML parser for versions 1.0 and 0.8. The parser depends on SnakeYaml, a Java YAML parser.
The old version that only support RAML 0.8 is still available here.
See http://raml.org for more information about RAML.
mvn clean package
mvn clean package -P jar-with-dependencies
Run standalone validator
java -jar raml-parser-2-{version}.jar raml-file ...
In order to provide more flexibility, users can set different system properties when parsing different RAML files. Here we list all the system properties you can use right now:
Argument | Description | Default Value |
---|---|---|
yagi.json_duplicate_keys_detection |
Setting it to true will make the parser fail if any JSON example contains duplicated keys | true |
raml.json_schema.fail_on_warning |
Setting it to true will make the parser fail if any example validated against a particular Json Schema throws a warning message | false |
RamlModelResult ramlModelResult = new RamlModelBuilder().buildApi(input);
if (ramlModelResult.hasErrors())
{
for (ValidationResult validationResult : ramlModelResult.getValidationResults())
{
System.out.println(validationResult.getMessage());
}
}
else
{
Api api = ramlModelResult.getApiV10();
}
To contribute source code to this repository, please read our contributor's agreement, and then execute it by running this notebook and following the instructions: https://api-notebook.anypoint.mulesoft.com/notebooks/#380297ed0e474010ff43
We are always thrilled to receive pull requests, and do our best to process them as fast as possible. Not sure if that typo is worth a pull request? Do it! We will appreciate it.
If your pull request is not accepted on the first try, don't be discouraged! If there's a problem with the implementation, hopefully you received feedback on what to improve.
Any significant improvement should be documented as a GitHub issue before anybody starts working on it.
Please take a moment to check that an issue doesn't already exist documenting your bug report or improvement proposal. If it does, it never hurts to thumb up the original post or add "I have this problem too". This will help prioritize the most common problems and requests.
The maintainers will review your pull request and, if approved, will merge into the main repo. Commits get approval based on the conventions outlined in the previous section. For example, new features without additional tests will be not approved.