The Redis docs are similar, albeit not quite as fancy. The reference page for each command includes a few example requests and their results -- and it's connected to a running Redis server, so you can actually type commands into it. Check it out:
Scripted.com API: Interactive Documentation
11–16 of 16 posts
Re: Scripted.com API: Interactive Documentation
#12The Redis docs are similar, albeit not quite as fancy. The reference page for each command includes a few example requests and their results -- and it's connected to a running Redis server, so you can actually type commands into it. Check it out: http://redis.io/commands/sadd
Love the redis docs! Redis powers the background queue at Scripted.
Re: Scripted.com API: Interactive Documentation
#13This is a nice take on the I/O Docs/API Explorer style (e.g. http://developer.mashery.com/iodocs ). Those sample JSON responses could really stand to get some pretty printing though. Don't provide example responses if they're unreadable. The post even touches on this ("An API’s documentation is its human interface") so it would nice to see them made more human-readable.
Yup, agree wholeheartedly! Will work on that shortly.
Re: Scripted.com API: Interactive Documentation
#14This looks very usable. Getting started tonight.
Re: Scripted.com API: Interactive Documentation
#15There should be a rule that if you have to write a wrapper for the API, then it's either poorly designed or poorly document, or both. Eg PayPal, Google, LinkedIn.
Re: Scripted.com API: Interactive Documentation
#16The Redis docs are similar, albeit not quite as fancy. The reference page for each command includes a few example requests and their results -- and it's connected to a running Redis server, so you can actually type commands into it. Check it out: http://redis.io/commands/sadd
Woah - I've used those docs dozens of times and never realized that the demos were interactive. I just assumed they were static examples. Thanks!