RAML

Overview

RESTful API Modeling Language (RAML) makes it easy to manage the whole API lifecycle from design to sharing. It's concise - you only write what you need to define - and reusable. It is machine readable API design that is actually human friendly.

Tutorials

RAML 100 Tutorial

API Workbench

Install

1. Install Atom editor

2. Install api-workbench package in Atom

RAML in our solution

Raml-files: GitHubExtension.EntryPoint\docs\raml

Html-doc: GitHubExtension.EntryPoint\docs\raml.html

Run gulp createHtmlDoc to create new version of html-doc from RAML