Adobe DITA World
Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers

Stitcher radio

Search results

Adobe DITA World

Tutorial for creating interactive consoles with RAML

by Tom Johnson on Oct 3, 2015
categories: api-doc

This is a tutorial for creating interactive consoles with the RAML spec. The interactive console allows users to try out your API directly in the documentation.

Following on the Swagger tutorial I posted about the other week, this week I’d like to point you to my RAML tutorial.

This is part of my larger API doc course, so in this tutorial I’m taking a simple Weather API from Mashape and putting the API’s endpoints, parameters, and sample responses into the RAML spec. Then I publish that API into several different RAML outputs using API Console, Mulesoft’s Anypoint Platform, and RAML2HTML.

In comparing RAML with Swagger, I think both are strong specifications for APIs. They’re definitely the top two. I like RAML’s tooling and design philosophy a lot, but Swagger probably has a more robust community. Both have a lot of momentum going on.

Stay current with the latest in tech comm
Keep current with the latest trends in technical communication by subscribing to the I'd Rather Be Writing newsletter. 4,500+ subscribers

follow us in feedly