As explained in the Primer for back-end development the RAML Module Builder (RMB) framework can be utilised to ease development. RAML files are also utilised in other ways (e.g. Okapi Web service and Tenant interface) and by other non-RMB modules.

Investigate the other raml-using server-side modules. The mod-notes is a compact exemplar.

The RMB README section entitled Design the RAML files provides some RMB-specific guidance, as well as general assistance. There is an example and commentary.

As explained there, use the shared git submodule at ramls/raml-util

When using RMB, it is important to further emphasise some items. Pay attention to the “$ref” used to reference and link JSON Schema, and to their declaration in the RAML files. At this stage RAML files must have at least two endpoints.

Use raml-cop to assess RAML, schema, and examples. A script is provided, to find files and run it. It can also be integrated with editors.

Reference API documentation is automatically generated by the continuous integration, for modules that are managed with the FOLIO CI.