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 an API technical writer based in the Seattle area. On this blog, I write about topics related to technical writing and communication — such as software documentation, API documentation, AI, information architecture, content strategy, writing processes, plain language, tech comm careers, and more. Check out my API documentation course if you're looking for more info about documenting APIs. Or see my posts on AI and AI course section for more on the latest in AI and tech comm.
If you're a technical writer and want to keep on top of the latest trends in the tech comm, be sure to subscribe to email updates below. You can also learn more about me or contact me. Finally, note that the opinions I express on my blog are my own points of view, not that of my employer.