[iks-community] Some guidelines to document API of RESTful services

[Henri Bergius]

Hi,

2009/11/16 Olivier Grisel <ogrisel at nuxeo.com>:
> For each method, we give the:
>
> - the query URL pattern
> - the HTTP method (GET, POST or even PUT, DELETE, ...)
> - the URL arguments with type info and human readable descriptions
> - the accepted media types of the payload (JSON, XML, RDF-XML, N3,
> binaries, ...)
> - a schema for the payloads (XSD, RDFS, ...)
> - a sample query with sample expected result (optional but really
> helpful to get a quick grasp)

Documenting the authentication methods is also important. But yeah,
we're pretty much trying to follow these conventions with Qaiku API
docs:

http://www.qaiku.com/api/usage/

> Olivier

/Henri

-- 
Henri Bergius
Nemein - Web Craftsmanship
http://nemein.com