Posted on 03-01-2014
As part of my research in the world of API design, I’m looking into the different approaches by API Blueprint, RAML and Swagger, to provide API definitions, services and tools that assist developers in better designing APIs. I have already look at the evolving motivations behind API definitions, and some insight into the vision behind Swagger, API Blueprint and RAML, next up is taking a look at the tooling that is emerged around each approach.
I began with a look at the tooling around Swagger, then I laid out what is offered around API Blueprint, from Apiary.io—next up, RAML which is developed by Mulesoft, and reflects the evolution of the API design space, making it much more attractive to the enterprise.
Like API Blueprint, RAML is a markdown based API description format, which is an evolution from the XML of WADL, and the JSON of Swagger. I think this approach to defining APIs has significance when exposing API design beyond the developers community, but only time will tell.
Everything RAML centers around the RESTful API Modeling Language:
- RESTful API Modeling Language (RAML) - A concise, expressive language for describing RESTful APIs. RAML is built on broadly used standards such as YAML and JSON and is a non-proprietary, vendor-neutral open spec.
With RAML interpreters available in JS and Java:
- RAML Java Parser - A reference implementation of a RAML parser for Java. It's based on SnakeYAML, and written in Java. It can be added as a Java library into a project directly or through Apache Maven. It is compliant with RAML 0.8, and provided under an Apache 2.0 license.
Beyond the RAML interpreter you start seeing some pretty sophisticated tooling for the API design process emerge:
- API Designer - A web-based API development tool that allows API providers to design their API quickly, efficiently, and consistently, and socialize the design. It consists of a RAML editor side-by-side with an embedded RAML console (the API Console). It is provided under the open-source CPAL license.
- API Console - A graphical user interface for a RAML-defined API that visually exposes the API’s structure and important patterns and serves as interactive API documentation. It is provided under the open-source CPAL license.
These API design tools reflect the open enterprise approach to software development from Mulesoft, but there is also other tooling emerging from within the RAML community:
- SoapUI RAML Plugin - SoapUI is a very popular functional testing tool, broadly used for testing APIs. It supports not only SOAP but also REST and any other HTTP APIs, as well as JMS, AMF and JDBC. The RAML plugin for SoapUI allows importing RAML descriptions of APIs into SoapUI to test those APIs. The plugin is provided under the open-source Apache 2.0 license.
- APIkit - A declarative toolkit that leverages RAML to facilitate the implementation of APIs. It uses RAML as the definition of the API, which can then be used with APIkit Maven- and Mule Studio-based tools for mocking the interface and implementing its backend using Mule flows. It is provided under the open-source CPAL license.
- RAML Store - A simple storage API plus a persistence plugin which enables you to run the RAML API Designer locally (rather than using a cloud service) and still be able to manage and collaborate on your design. The service is built with node.js, using express and mongodb.
- JAX-RS Codegen - A set of Java tools that support an API-first approach to implementing RAML-described RESTful services in Java with JAX-RS. Given a RAML specification of an API, it generates corresponding JAX-RS-annotated interfaces and supporting classes, which can be used in your project to implement those spec-compliant APIs. This project is in early alpha. It is provided under the open-source Apache 2.0 license.
- RAML Sublime Plugin - This is a simple syntax highlighter for Sublime that provides support for the RESTful API Modeling Language (http://raml.org/). It is provided under the open-source Apache 2.0 license.
When reviewing the tooling for RAML, you can tell some serious planning has gone into it. Wordnik was developing open tooling based upon their immediate needs, and Swagger just happened, with API Blueprint being designed to match the API design workflow of Apiary. Mulesoft obviously had time to put a plan together when it came to RAML, based upon what they already saw occurring in the space, and their own experience.
When it comes to tools that facilitates the API design process, RAML is definitely the leader. However Swagger and API Blueprint definitely enjoy a first mover lead in the world of delivering API design services. I’m not convinced a first mover advantagee, or a suite of well designed tooling will be more valuable to developers—I will play with actually designing and deploying each platform next, to see what I learn by actually using Swagger, API Blueprint and RAML to design a basic API.
comments powered by Disqus
Winning in the API Economy
|Download as PDF|
Latest Blog Posts
- On Being An API Broker For Hackathons
- Are You A Hypermedia Pragmatist?
- Do You Know That Hypermedia Is A Better Solution For Discovery Than APIs.json?
- API Service Idea: API Via Excel From Within Corporate Email
- With Number Of APIs Continuing To Grow Account Automation Will Be Key
- History Of APIs: NOAA APIs Have Been RESTful For Over 20 Years
- Understanding More About The Web Communications Platform Respoke
- Swagger Definition Driven Sandbox And Simulation Data Templates For APIs
- Swagger API Definition Mapper
- Moving Beyond Just The PDF With A Single Page Report (SPR)