public class RamlVerifier extends Object
| Modifier and Type | Field and Description |
|---|---|
protected static org.slf4j.Logger |
logger
Class Logger
|
| Constructor and Description |
|---|
RamlVerifier(RamlRoot published,
RamlRoot implemented,
List<RamlChecker> checkers,
List<RamlActionVisitorCheck> actionCheckers,
List<RamlResourceVisitorCheck> resourceCheckers)
Constructor which will accept target/implementation RAML models as well as the the checkers to be applied.
|
RamlVerifier(RamlRoot published,
RamlRoot implemented,
List<RamlChecker> checkers,
List<RamlActionVisitorCheck> actionCheckers,
List<RamlResourceVisitorCheck> resourceCheckers,
List<RamlStyleChecker> styleChecks)
Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.
|
RamlVerifier(RamlRoot published,
RamlRoot implemented,
List<RamlChecker> checkers,
List<RamlActionVisitorCheck> actionCheckers,
List<RamlResourceVisitorCheck> resourceCheckers,
List<RamlStyleChecker> styleChecks,
String implementedUrlPrefixToIgnore)
Constructor which will accept target/implementation RAML models as well as the the checkers and style checkers to verify.
|
| Modifier and Type | Method and Description |
|---|---|
Set<Issue> |
getErrors()
Retrieve the Errors identified
|
Set<Issue> |
getWarnings()
Retrieve the Warnings identified
|
boolean |
hasErrors()
Checks if there are any errors generated during the comparison
|
boolean |
hasWarnings()
Checks if there are any warnings generated during the comparison
|
static RamlRoot |
loadRamlFromFile(String ramlFileUrl)
Loads a RAML document from a file.
|
public RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers, List<RamlStyleChecker> styleChecks)
published - The RAML model from the published RAML fileimplemented - The RAML model built from the Spring MVCcheckers - Checkers that will be applied to the modelsactionCheckers - Checker Visitors that will trigger to compare individual actionsresourceCheckers - Checker Visitors that will trigger to compare individual resourcesstyleChecks - Style Checks that will be applied to the modelspublic RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers, List<RamlStyleChecker> styleChecks, String implementedUrlPrefixToIgnore)
published - The RAML model from the published RAML fileimplemented - The RAML model built from the Spring MVCcheckers - Checkers that will be applied to the modelsactionCheckers - Checker Visitors that will trigger to compare individual actionsresourceCheckers - Checker Visitors that will trigger to compare individual resourcesstyleChecks - Style Checks that will be applied to the modelsimplementedUrlPrefixToIgnore - The Portion of the url to ignore from the implementation. use this to align urls as an alternative to baseUripublic RamlVerifier(RamlRoot published, RamlRoot implemented, List<RamlChecker> checkers, List<RamlActionVisitorCheck> actionCheckers, List<RamlResourceVisitorCheck> resourceCheckers)
published - The RAML model from the published RAML fileimplemented - The RAML model built from the Spring MVCcheckers - Checkers that will be applied to the modelsactionCheckers - Checker Visitors that will trigger to compare individual actionsresourceCheckers - Checker Visitors that will trigger to compare individual resourcespublic boolean hasErrors()
public boolean hasWarnings()
public static RamlRoot loadRamlFromFile(String ramlFileUrl)
ramlFileUrl - The path to the file, this can either be a resource on the class path (in which case the classpath: prefix should be omitted) or a file on disk (in which case the file: prefix should be included)public Set<Issue> getErrors()
Copyright © 2017. All rights reserved.