RESTdesc captures functionality.
RESTdesc is a method to describe the functionality of hypermedia APIs, letting machines autonomously discover what an API does.
Functionality captures the essentials.
If someone asks you to define a GPS navigator, what would you answer?
A GPS navigator is a device that takes text as input
and then outputs audio.
You could, but that wouldn't be helpful to determine if we need this device.
This is why you would likely talk about functionality instead:
If you give an address to a GPS navigator,
then it will say the driving directions to that address.
Now any person is able to decide whether he or she needs this GPS navigator.
Strangely, most past description efforts have focused on giving the first answer, emphasizing the technical input and output parameters of a service or API.
RESTdesc describes functionality with semantics.
RESTdesc is different: it gives the second answer, which is what you really need.
By describing functionality, RESTdesc opens up your API for automated agents.
Its benefits – beside being free and open – include:
- fully reusing existing vocabularies on the Semantic Web,
- built with today's Semantic Web technologies and tools,
- designed for compactness and elegance.
Using RESTdesc for your API is a great idea, because:
- RESTdesc loves resource-oriented (REST) APIs and their hypermedia links.
- You don't need new tools, since current software understands RESTdesc.
- You have to describe only what you need and nothing more.
You can learn RESTdesc easily.
Describing your API in RESTdesc is easy and this website will show you how.
First, check out what RESTdesc descriptions look like.
Then, dive into discovery methods.
Do you have any questions?
Discuss them with us, we're looking forward to listen and help.