RestDoc retrieval via the OPTIONS method

Jump to bottom Edit New page

grncdr edited this page Apr 20, 2012 · 4 revisions

RestDoc is designed to be consumed via regualr HTTP requests.

The HTTP method that was chosen for retrieving the RestDoc data is OPTIONS.

Standard root level RestDoc request

OPTIONS *
Accept: application/json

The response will contain the full description of the available resources and their supported methods.

Standard resource level RestDoc request

OPTIONS /resource
Accept: application/json

The response will contain resource level description of the supported methods.