The purpose of this plugin is to provide syntax checking and documentation generator for your RAML API definitions.
It exposes two tasks: raml:verify and raml:doc. The verify task performs syntax and include resolution checks,
if it succeeds, then your RAML definitions are valid, and can be used in some testing tool. The doc task takes the
RAML definitions and generates HTML documentations.
Write the RAML descriptors in src/raml. Your RAML files can include other RAML files, the verifier and documentation generator follows the naming & directory structure. To include the verifier and documentation generator, add the plugin to your project/plugins.sbt by
addSbtPlugin("org.eigengo" % "sbt-raml" % "0.1-SNAPSHOT")Once you have the plugin, add
org.eigengo.sbtraml.RamlPlugin.settingsto your build.sbt. This will add the RAML verify check to the compile task and documentation task to the
publishLocal task.
You can also execute the raml:mock task, which will expose your APIs in your project on the interface, port in
MockSettings. In the mock server, you can specify the HTTP header that you can pass to the mock server to
indicate which response (out of the many possible ones) you'd like the server to return; the timeout you'd like
the server to take, and an indicator for errors.
settings in Raml := MockSettings(interface = "localhost", port = 8100,
responseCodeHeaderName = "X-Code",
responseTimeHeaderName = "X-Time",
failResponseHeaderName = "X-Fail")Then set these HTTP headers on the request to indicate which response code to send, whether to fail (return 503), and how long to take before returning a response.
Notes:
Both tasks use the source in Raml setting to point to a directory where the RAML files live. Future versions will
probably need stylesheet in Raml to indicate the location of a CSS file for the documentation, and target in Raml
to specify the output directory for the HTML documentation.