A simple RAML to HTML documentation generator, written for Node.js. Check raml2md for a RAML to Markdown generator.

Code Quality Rank: L5
Monthly Downloads: 0
Programming language: JavaScript
License: MIT License
Tags: REST Frameworks     RAML    
Latest version: v7.5.0

RAML alternatives and similar libraries

Based on the "REST Frameworks" category.
Alternatively, view RAML alternatives based on common mentions on social networks and blogs.

  • Retrofit

    A type-safe HTTP client for Android and the JVM
  • Dropwizard

    A damn simple library for building production-ready RESTful web services.
  • The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
  • Spark

    9.1 0.0 L3 RAML VS Spark
    A simple expressive web framework for java. Spark has a kotlin DSL https://github.com/perwendel/spark-kotlin
  • Feign

    9.1 9.3 L4 RAML VS Feign
    Feign makes writing java http clients easier
  • rest.li

    Rest.li is a REST+JSON framework for building robust, scalable service architectures using dynamic discovery and simple asynchronous APIs.
  • RESTEasy

    An Implementation of the Jakarta RESTful Web Services Specification
  • Swagger

    The content of swagger.io
  • Rapidoid

    Rapidoid - Extremely Fast, Simple and Powerful Java Web Framework and HTTP Server!
  • RestExpress

    Minimalist Java framework for rapidly creating scalable, containerless, RESTful microservices. Ship a production-quality, headless, RESTful API in the shortest time possible. Uses Netty for HTTP, Jackson for JSON, Metrics for metrics, properties files for configuration. Sub-projects and plugins enable, NoSQL, Swagger, Auth0, HAL integration, etc.
  • Microserver

    Microserver is a Java 8 native, zero configuration, standards based, battle hardened library to run Java Rest Microservices via a standard Java main class. Supporting pure Microservice or Micro-monolith styles.
  • Jersey

    Eclipse Jersey Project - Read our Wiki:
  • Restlet Framework

    Leading REST API framework for Java
  • Hexagon

    Hexagon is a microservices toolkit written in Kotlin. Its purpose is to ease the building of services (Web applications or APIs) that run inside a cloud platform.
  • RestX

    4.6 8.5 L2 RAML VS RestX
    RESTX, the lightweight Java REST framework
  • Crnk

    JSON API library for Java
  • StubbornJava

    Unconventional Java code for building web servers / services without a framework. Think dropwizard but as a seed project instead of a framework. If this project had a theme it would be break the rules but be mindful of your decisions.
  • gemini

    Cloud Native and Low Code Platform to create FullStack web Admin applications in minutes
  • Restler

    Restler is a library that automatically generates a client for a web service at run time, by analyzing the respective annotated Spring controller interface

Do you think we are missing an alternative of RAML or a related project?

Add another 'REST Frameworks' Library


A simple RAML to HTML documentation generator, written for Node.js, with theme support.

RAML version support

raml2html 4 and higher only support RAML 1.0 files. Please stick with raml2html 3.x for RAML 0.8 support.


npm i -g raml2html


raml2html ships with a default theme, but you can install more from NPM. For example, to render RAML to Markdown, you can install the raml2html-markdown-theme theme:

npm i -g raml2html-markdown-theme

Search NPM for the "raml2html-theme" keyword (or use this link) to find more themes.


As a command line script

raml2html --help
raml2html example.raml > example.html
raml2html --theme raml2html-markdown-theme example.raml > example.html
raml2html --template my-custom-template.nunjucks -i example.raml -o example.html

As a library

Using the default theme, different themes, or your own Nunjucks templates

const raml2html = require('raml2html');
const configWithDefaultTheme = raml2html.getConfigForTheme();
const configForDifferentTheme = raml2html.getConfigForTheme('raml2html-markdown-theme');
const configWithCustomTemplate = raml2html.getConfigForTemplate('~/path/to/my-custom-template.nunjucks');

// source can either be a filename, url, or parsed RAML object
raml2html.render(source, configWithDefaultTheme).then(function(result) {
  // Save the result to a file or do something else with the result
}, function(error) {
  // Output error

Using your own processing function, for full control over the whole rendering process

 * config should be an object with at least an `processRamlObj` property which is a function that receives the raw RAML
 * object and must return a promise with the result. You can do whatever you want in this function.
 * You can also supply a postProcessHtml function that can for example minify the generated HTML.
 * You can also supply a writeOutput function that takes over writing the output (to disk for example).
 * You can also supply a setupNunjucks function that takes the env as its only parameter.
raml2html.render(source, config).then(function(result) {
  // Save the result to a file or do something else with the result
}, function(error) {
  // Output error

See also examples/script.js for multiple examples of using raml2html as a library.

Example output

Please see the following links for live examples:

Before you report a bug

If you get parsing errors, please do not report them to raml2html: it doesn't do the actual RAML parsing. Review the error and fix your RAML file, or open a new issue at raml-js-parser-2.


raml2html is an open source project and your contribution is very much appreciated.

  1. Check for open issues or open a fresh issue to start a discussion around a feature idea or a bug.
  2. Fork the repository on Github and make your changes on the develop branch (or branch off of it). Run npm run lint before committing to check for common problems and auto format all code.
  3. Add an example of the new feature to example.raml (if applicable)
  4. Send a pull request (with the develop branch as the target).

If your pull request is merged feel free to ask for push access. We want to get more maintainers! If you do have push access, please still work on feature branches and create pull requests, which then get reviewed. You can also review other people's pull requests and be involved in that way.

A big thank you goes out to everyone who helped with the project, the contributors and everyone who took the time to report issues and give feedback.

Local setup

To get the best environment to work on raml2html and the default theme, follow these steps.

  1. Checkout raml2html-default-theme's develop branch; npm link.
  2. Checkout raml2html's develop branch; first npm link raml2html-default-theme and then npm link.
  3. In raml2html-default-theme run npm link raml2html.

Now both projects are installed globally, but using the local development versions of both. From the theme repo's examples folder you can run the render-all-examples script without problem.


See changelog.md


raml2html is available under the MIT license. See the LICENSE file for more info.

*Note that all licence references and agreements mentioned in the RAML README section above are relevant to that project's source code only.