Custom Specification

While the library provides 3 different RAML specifications, they may not meed your specific needs for exposing a specification for testing.

The RamlSpecification class is an abstract class that can be extended. The only expectation is that the implementation will expose the getRaml() method.

This way, a developer can load a RAML specification as they need to.

Example

public class MyCustomSpecification extends RamlSpecification {
    private final String serviceName;

    public MyCustomSpecification(String name, String serviceName) {
        super(name);
        this.serviceName = serviceName;
    }

    @Override
    public Raml getRaml(){
        File sharedPathFile = new File(String.format("/path/to/shared/fileserver/location/%s.yml", serviceName));

        if (!sharedPathFile.exists())
            throw new IllegalArgumentException("Specification does not exist for provided service.");

        ResourceLoader loader = new FilePathLoader(sharedPathFile.getParent());

        String raml = FileUtils.readFileToString(sharedPathFile);
        return new RamlDocumentBuilder(loader).build(raml, "/");
    }
}