Tutorial for creating interactive consoles with RAML
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.
About Tom Johnson
I'm a technical writer based in the San Francisco Bay area. In this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, visual communication, information architecture, writing techniques, plain language, tech comm careers, and more. Check out simplifying complexity and API documentation for some deep dives into these topics. If you're a technical writer and want to keep on top of the latest trends in the field, be sure to subscribe to email updates. You can also learn more about me or contact me.