Overview of RESTful API Description Languages: Difference between revisions

Revision as of 01:46, 19 March 2015

Revision as of 15:20, 19 March 2015

Line 1:

{{Orphan|date=March 2015}}

'''''RESTful''''' (REpresentational State Transfer) '''''API''''' (Application Programming Interface) '''''DLs''''' (Description Languages) are [[formal languageslanguage]]s designed to provide a structured description of an RESTful[[REST]]ful [[API]] that is useful both to a human and for automated machine processing. API Description Languages are sometimes called [[Interface Description Language]]s The structured description might be used to generate a documentation for human programmers[[programmer]]s; such documentation is easier to read than free-form document since every documentation generated by the same tool follows the same formatting conventions. Additionally, the description language is usually precise enough to allow automated generation of various software artifacts, like libraries to access the API from various programming languages, which takes the burden of manually creating them off the programmers.

==History==

Line 10:

<!-- TODO: make it a table -->

<!-- Name, DateURL, Developer, Note, Refs -->

*WSDL

*WADL

*Swagger

**developer: Reverb, https://helloreverb.com/

*RAML

**developer: Mulesoft, http://www.mulesoft.com/

*Hypermedia

*API Blueprint

*I/O Docs

*IdDoos

**developer: Mashery, http://www.mashery.com/

*[[Apache Avro]]

*Barrister

**http://barrister.bitmechanic.com/

==List of data description languages==

*json:api

**http://jsonapi.org/

**Started as REST adapter for [[Ember.js|Ember]] Data

*JSON Schema

**used by Swagger, Google APIs Discovery<ref>https://developers.google.com/discovery/v1/reference/apis</ref>, I/O Docs

*Apache Avro

**https://avro.apache.org/

**both Interface Description Language and data description language

*JSON-RPC 2.0

**used by Barrister

==Comparison of RESTful API DLs==

Line 77 ⟶ 96:

{{Reflist}}

==External links==

*[http://www.mayerdan.com/programming/2014/01/29/investigating-api-tooling/ Investigating Api Developer Tooling]

{{software-stub}}