REST API Descriptive Language (API DL)

Rest (Representational State Transfer) webservice style is getting widespread acceptance across the Web fraternity. Industries and software communities are looking alternative to SOAP and WSDL based webservice. To compete with SOAP and WSDL based webservice REST need to support Descriptive Language based API.

Webservices APIs that follow and apply to the REST architectural constraints are called RESTful APIs. API descriptive language need to include blueprint of service, contract of service, metadata of service and documentation of service.

Many REST API descriptive language (API DL) are available today. Here I am discussing top 3 active API DL available for REST.


RAML — RAML is sponsored by MuleSoft. RAML Built on broadly used standards such as YAML and JSON, written in CoffeeScript, and can be used as a node.js. This is one of the very famous API DL and widely use with MuleSoft ESB. RAML support blueprint and contract of service design before you start your original coding. RAML API design approach is top-down. Writing spec for RAML is simple, human readable format.

SWAGGER – Sawwagger is sponsored by couple of companies like Apigee, Reverb and supported  with a large number active developer communities. Swaager format is based on JSON but they also support YAML. Swagger right now doesn’t support design before code. SWAGGER API design approach is bottom-up. Writing spec for SWAGGER  looks incomplete.

API Blueprint – API blueprint is sponsored by Apiary.API blueprint is based on Markdown. Markdown is a text-to-HTML conversion tool for web writers. There is no active developer community support for API Blueprint. API Blueprint right now doesn’t support design before code and its design approach is top-down. Writing spec for API Blueprint is simple and easy.

This entry was posted in Java, mulesoft, SOA by Rajnish Kumar. Bookmark the permalink.
Rajnish Kumar
Follow me

Rajnish Kumar

Entrepreneur, Associate MuleSoft Developer certified and Java Programmer Sun certified with over 19 years in Project Management, Architecture of Enterprise application and application development . Complete Software Life Cycle Experience for Multi-Tier Systems, involving Scope, Specifications, Architecture, Design, Estimation, Parallel Iterative Development, Integration, Testing, Release, Revision, and Maintenance. Extensively worked on IOT, Microservices, APIs,SOA application, Cloud, Amazon AWS, Big Data, Analytics, Artificial intelligence and Security(Application Security, Web Security, Data Security)

One thought on “REST API Descriptive Language (API DL)

  1. that was very good article , but would have been more appreciated if it had depth about each API DL

Leave a Reply

Your email address will not be published. Required fields are marked *