Daisy API Docs Up

Posted: November 17th, 2005 | Author: admin | Filed under: Daisy | View Comments

They ain’t pretty but my first cut at documenting Daisy’s external API is available here.

Daisy’s external API is designed around REST principles. I did this to make the API available to as wide a range of languages as possible. I am considering adding a complementary XML-RPC version but that’s still up in the air.

I think REST APIs make for very readable APIs especially if the endpoint URLs are sufficiently descriptive. Here’s a couple of examples from Daisy’s API:

http://localhost:9191/daisy/rest/query?queryString=ruby+on+rails&archives=t

http://localhost:9191/daisy/rest/archive?archive=119

The first example performs a search engine query. The second retrieves a resource from Daisy’s storage and streams it back to the caller.

As always, feedback on the API or Daisy in general is appreciated. Send it here.


Comments are closed.