Automatically Building API Documentation Helps Gadgeteers

automatically-building-api-documentation-helps-gadgeteers photo 1


There's a close relationship between APIs and building interesting gadgets. Sending commands to hardware to control it or gathering data from sensors and pushing it to the cloud, that's most likely being done through APIs.

Restlet's New "Gutenberg" Technology Automatically Builds API Documentation

I am an organizer for the RICOH THETA Unofficial Guide, a free information community site focused on the popular 360° camera, and we deal with API issues all the time. Easier ways to test APIs are essential. Getting, producing, and updating documentation around APIs is very closely related.

We have used DHC by Restlet to show the RICOH THETA API to developers. We found it easier to use than curl or a web browser for testing. We were also able to save our HTTP tests in DHC and easily call them up to demonstrate to developers. That's cool.

DHC played an important role in the development of our API usage documentation. Currently, our developer documentation gets 30,000 views a month from developers. This started off at zero less than a year ago. In addition to serving as the basis for our HTTP usage tutorial, I was pleasantly surprised that the HTTP response could display images, allowing us to directly test image transfer from the camera to a browser inside of DHC.

Restlet's new technology for automatically building API documentation combines nicely with their API testing products. It automagically creates and publishes API documentation. It can handle major API specification languages such as OAS and RAML. And it's easy to import from one language and export to another.

Think about APIs when you start your next hardware project. What are you doing for testing? How are you handling API documentation? Restlet's tools are a good place to start.

More stories

The Best Cheap Web Hosting Services of 2016

You don't need Scrooge McDuck bucks to build a website. These eight PCMag-approved Web hosting services can get your business online without putting a dent in your bank account.

Why Fleet Tracking Software Is Worth It

The most important concern for fleets is fuel costs. This fluctuating cost variable makes the entire operation work - literally - but is very hard to predict or...