Tag Archives: RAML

RAMLfications – Python package to parse RAML


A few of us at Spotify are infatuated with RAML – a RESTful API Modeling Language described as “a simple and succinct way of describing practically-RESTful APIs”, extremely similar goal of Swagger. I’m pleased to announce the initial release of RAMLfications, a Python package that parses RAML and validates it based on the specification into Python objects.

http://labs.spotify.com/2015/04/21/ramlfications/

API Best Practices: Spec Driven Development


via API Best Practices: Spec Driven Development | MuleSoft Blog.

Define Your API in a Flexible, but Standard Spec

I cannot stress the importance of spec driven development enough.  One of the quickest ways to kill your API is to define the API in your code, instead of coding to its definition.  By utilizing an API modeling spec such as RAML you can quickly build out your API in a consistent manner using code and pattern reuse.

Utilizing pattern design and code reuse helps to ensure that your API remains uniform across the full interface, keeping resources and methods alike standardized and easily implemented by your developers.

Tools like API Designer allow you to view your API as it is being designed and watch for inconsistencies/ dependencies you might have missed otherwise.  And perhaps most importantly, once your spec is in place it keeps everyone on the same page, ensuring that your API works exactly the way you want it to.

RESTifying Your Business Data with REST APIs


What is API Notebook?
The API Notebook is a web-based, persistent, JavaScript scripting workspace that enables the live exploration of APIs, testing APIs, and working through use cases. The notebook auto-generates an API client by pointing it to the API’s RAML description.

API Notebook enables developers to create interactive API examples, runnable JavaScript snippets, and is embedded anywhere. You can create scripts and it automatically saves them as Gists in GitHub, so they’re forkable and shareable. They’re also a great example of literate programming.

In his talk, API Notebook creator Uri Sarid, current CTO at MuleSoft discusses API Notebook and its basic capabilities. He also gives an introduction to RAML, a simple way to describe a REST API. He is co-author of the RAML specification, a YAML-based language to describe practically-RESTful APIs.