JSON-ROA

JSON-ROA - a JSON extension for resource and relation oriented architecture providing explorable APIs for humans and machines.

Objectives and Properties

For RESTful HTTP

JSON-ROA is well suited for API build with REST in mind.

Unobtrusive

JSON-ROA is designed to interfere as minimal as possible with the JSON structure. Support for existing RESTful APIs can added easily without breaking existing clients.

Simplicity

JSON-ROA does a few things very well, at least much better than the existing proposals we found elsewhere. It favors simplicity over excessive flexibility.

For Humans

We believe that there is value in providing tools such that humans can understand a API quickly and naturally. JSON-ROA features The JSON-ROA Browser to explore APIs.

For Programmers

JSON-ROA is designed such that clients can be programmed with little effort and minimal risk of getting it wrong.