ramlrenderer

master branch1 version

master branchlatestSep 1, 2016

github.com/beno/ramlrenderer

HTLM doc builder for RAML 1.0

4 stars

0 dependents

License: not declared

Installation

# Add this to your shard.yml
dependencies:
  ramlrenderer:
    github: beno/ramlrenderer
    branch: master

master is a branch, not a release, so this tracks it rather than pinning a version.

Then run:

shards install

shard.yml

Crystal: no constraint declared

Dependencies

Runtime Dependencies

kilt*github: jeromegn/kilt
slang*github: jeromegn/slang, branch: master
minitest*github: ysbaddaden/minitest.cr
commander~> 0.3.3github: mrrooijen/commander
zip-crystal*github: pablotron/zip-crystal

README

RAMLRenderer

HTML documentation builder for RAML 1.0

Usage

Install

$ crystal dep

Compile

$ crystal compile ramlrenderer.cr

Run

$ ./ramlrenderer -i api.raml -o docs.html   #with flags
$ ./ramlrenderer api.raml > docs.html       #alternative

Develop

$ crystal ramlrenderer.cr -- -i api.raml -o docs.html

Limitation

This is only a partial implementation so far. More to come.

Due to Crystal's macro implementation the template name has to be hard coded (./template/api.slang). So for different layouts, this file must be edited/replaced and the program must be recompiled.

Roadmap

The plan is to grow this into a fully compliant RAML 1.0 parser. Next steps:

merge includes (done)
merge resourceTypes & traits into resources (done)
merge data types (done)
interpolate <<variables>> in resourceTypes, traits, etc (done)
handle examples (done)
handle headers (done)
handle query strings (done)
handle security setting
error handling (done)