RAML (software)

RAML
Filename extension	.raml
Internet media type	application/raml yaml
Developed by	RAML Workgroup
Latest release	1.0; May 16, 2016
Extended from	YAML
Standard	github.com/raml-org/raml-spec/blob/master/versions/raml-10/raml-10.md/
Website	raml.org

RESTful API Modeling Language (RAML) is a YAML-based language for describing static APIs (but not REST APIs).^[2] It provides all the information necessary to describe APIs on the level 2 of the Richardson Maturity Model. Although designed with RESTful APIs in mind, RAML is not capable of describing APIs that obey all constraints of REST (it cannot describe an API obeying HATEOAS, in particular). It encourages reuse, enables discovery and pattern-sharing and aims for merit-based emergence of best practices.^[3]

History

RAML was first proposed in 2013. The initial RAML specification was authored by Uri Sarid, Emiliano Lesende, Santiago Vacas and Damian Martinez, and garnered support from technology leaders like MuleSoft, AngularJS, Intuit, Box, PayPal, Programmable Web and API Web Science, Kin Lane, SOA Software, and Cisco.^[4] Development is managed by the RAML Workgroup.^[5] The current workgroup signatories include technology leaders from MuleSoft (Uri Sarid, CTO), AngularJS (Misko Hevery, Project Founder), Intuit (Ivan Lazarov, Chief Enterprise Architect), Airware (Peter Rexer, Director of Product - Developer Platform), Programmable Web and API Science (John Musser, Founder), SOA Software (Tony Gullotta, Director of Development), Cisco (Jaideep Subedar, Senior Manager, Product Management - Application Integration Solutions Group), VMware (Kevin Duffey, Senior MTS Engineer), Akamai Technologies (Rob Daigneau, Director of Architecture for Akamai's OPEN API Platform) and Restlet (Jerome Louvel, CTO and Founder). RAML is a trademark of MuleSoft.^[6]

Very few existing APIs meet the precise criteria to be classified as RESTful APIs. Consequently, like most API initiatives in the 2010s, RAML has initially focussed on the basics of APIs including resources, methods, parameters, and response bodies that need not be hypermedia. There are plans to move towards more strictly RESTful APIs as the evolution of technology and the market permits.^{[citation needed]}

There are a number of reasons why RAML has broken out from being a proprietary vendor language and has proven interesting to the broader API community:^[7]

RAML has been open-sourced along with tools and parsers for common languages. The development of RAML will be overseen by a steering committee of API and UX practitioners, and there is an emerging ecosystem of third-party tools being developed around RAML^[8]
MuleSoft originally started using Swagger (now OpenAPI Specification), but decided it was best suited to documenting an existing API, not for designing an API from scratch. RAML evolved out of the need to support up-front API design in a succinct, human-centric language^[9]
API descriptions are often verbose and repetitive, which can make them difficult to understand and use, and slow adoption of the APIs. RAML has introduced language features that support structured files and inheritance that address cross-cutting concerns^[10]

A new organization, under the sponsorship of the Linux Foundation, called the Open API Initiative was set up in 2015 to standardize the description of HTTP APIs. A number of companies including SmartBear, Google, IBM and Microsoft were founding members.^[11]^[12] SmartBear donated the Swagger specification to the new group. RAML and API Blueprint are also under consideration by the group.^[13]^[14]

Example

This is an example RAML file. As with YAML, indentation shows nesting.

  #%RAML 0.8

  title: World Music API
  baseUri: http://example.api.com/{version}
  version: v1
  traits:
    - paged:
        queryParameters:
          pages:
            description: The number of pages to return
            type: number
    - secured: !include http://raml-example.com/secured.yml
  /songs:
    is: [ paged, secured ]
    get:
      queryParameters:
        genre:
          description: filter the songs by genre
    post:
    /{songId}:
      get:
        responses:
          200:
            body:
              application/json:
                schema: |
                  { "$schema": "http://json-schema.org/schema",
                    "type": "object",
                    "description": "A canonical song",
                    "properties": {
                      "title":  { "type": "string" },
                      "artist": { "type": "string" }
                    },
                    "required": [ "title", "artist" ]
                  }
              application/xml:
      delete:
        description: |
          This method will *delete* an **individual song**

Some highlights:

line 7, 12: defines traits, invoked in multiple places
line 12: an Include file
line 13, 14: define a "resource" data type "/songs"; uses previously defined traits
line 15, 19, 37: defines HTTP methods
line 25, 36: MIME types.

API gateways supporting RAML

Apigee
MuleSoft
AWS API Gateway by AWS (through AWS API Gateway Importer)
Akana
Restlet

Furthermore, you can convert your RAML specification to either OpenAPI or API Blueprint using APIMATIC, thus enabling you to use further API gateways.

Alternative HTTP API Modeling Languages

Notes

^ Not registered with IANA

References

^ "Announcing RAML 1.0 GA | RAML Blog". Retrieved 11 August 2016.
^ "RAML 100.o". GitHub. Retrieved 26 May 2017.
^ "RAML — RESTful API Modeling Language". Retrieved 15 July 2014.
^ "RAML or OpenAPI - How About Both? - DZone Integration". dzone.com. Retrieved 2017-10-04.
^ "RAML Workgroup".
^ "RAML - Trademark Details". 26 May 2017.
^ "Why RAML is More than Another Proprietary Specification". 11 April 2014.
^ "API Design Tooling From RAML". 3 March 2014.
^ "Anypoint for APIs: An Interview with Uri Sarid". 25 February 2014.
^ "An Example of API Design using RAML". 11 April 2014.
^ "SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger". ProgrammableWeb. 2015-11-10. Archived from the original on 2016-11-09. Retrieved 2016-04-21.
^ "New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services". www.linuxfoundation.org. Archived from the original on 2016-04-27. Retrieved 2016-04-22.
^ Montcheuil, Yves de (14 December 2015). "In 2016, the need for an API meta-language will crystallize". InfoWorld. Retrieved 2016-04-25.
^ "Amazon API Gateway Now Supports Swagger Definition Import". InfoQ. Retrieved 2016-04-25.

External links

[1] Not registered with IANA

[2] "Announcing RAML 1.0 GA | RAML Blog". Retrieved 11 August 2016.

[spec-3] "RAML 100.o". GitHub. Retrieved 26 May 2017.

[4] "RAML — RESTful API Modeling Language". Retrieved 15 July 2014.

[5] "RAML or OpenAPI - How About Both? - DZone Integration". dzone.com. Retrieved 2017-10-04.

[6] "RAML Workgroup".

[7] "RAML - Trademark Details". 26 May 2017.

[8] "Why RAML is More than Another Proprietary Specification". 11 April 2014.

[9] "API Design Tooling From RAML". 3 March 2014.

[10] "Anypoint for APIs: An Interview with Uri Sarid". 25 February 2014.

[11] "An Example of API Design using RAML". 11 April 2014.

[12] "SmartBear, Linux Foundation launch Open API Initiative to Evolve Swagger". ProgrammableWeb. 2015-11-10. Archived from the original on 2016-11-09. Retrieved 2016-04-21.

[13] "New Collaborative Project to Extend Swagger Specification for Building Connected Applications and Services". www.linuxfoundation.org. Archived from the original on 2016-04-27. Retrieved 2016-04-22.

[14] Montcheuil, Yves de (14 December 2015). "In 2016, the need for an API meta-language will crystallize". InfoWorld. Retrieved 2016-04-25.

[15] "Amazon API Gateway Now Supports Swagger Definition Import". InfoQ. Retrieved 2016-04-25.

[n 1]

[1]

[2]

[3]

[4]

[5]

[6]

[7]

[8]

[9]

[10]

[11]

[12]

[13]

[14]