Re:Scripted.com API: Interactive Documentation
by johns on Wednesday May 09, 2012 @07:20PM
(#3951010)
This 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.
Re:Scripted.com API: Interactive Documentation
by pjscott on Wednesday May 09, 2012 @08:01PM
(#3951142)
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:
Re:Scripted.com API: Interactive Documentation
by rbucks on Thursday May 10, 2012 @12:29AM
(#3951858)
There 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.
Basic flow:
Use a feed to parse and generate topics Push blog article jobs to Scripted Pull finished content from Scripted Post content to your CMS
We'll write another blog post about it in a couple of weeks.
http://redis.io/commands/sadd