Scripted.com API: Interactive Documentation(blog.scripted.com)

24 pointsby rmorrison14 lat temu14 comments

blog.scripted.com

Scripted.com API: Interactive Documentation

http://blog.scripted.com/dev/interactive-documentation/

15 comments

pjscott14 lat temu

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:

http://redis.io/commands/sadd

smanek14 lat temu

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!

jbkring14 lat temu

Love the redis docs! Redis powers the background queue at Scripted.

[deleted]14 lat temu

irinai14 lat temu

This will be great for small businesses!

rausanka14 lat temu

Some of the most beautifully formatted API docs I've ever seen. It's really nice to have design care applied to developer pages.

cpdean14 lat temu

i love the recent upgrade to git-scm http://git-scm.com/docs/git-rebase

jbkring14 lat temu

thanks! but i have to give credit where credit is due: bootstrap.

Matt_Mickiewicz14 lat temu

I'm really excited to see what will be done with this.

johns14 lat temu

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.

jbkring14 lat temu

Yup, agree wholeheartedly! Will work on that shortly.

rbucks14 lat temu

With the Scripted API, you can build a self-publishing website in < 50 lines of code. We're publishing to our own magazine sites using this API!

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.

rupatejura14 lat temu

Excellently scripted API doc.

amantesting14 lat temu

This looks very usable. Getting started tonight.

rbucks14 lat temu

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.