Example of API documentation auto generation

source file: here

/precondition

*

*

Preconditions:

Accept: text/plain
HTTP/1.1 only
user defined precondition.

precondition test

/api/documentation

GET

GET

this page

cat group

/api/cat

POST

GET

GET

get current name and age.

POST

set name and age from query parameter.

Query parameters
name	num	type	description
name	first	Text?	no description
age	option	Int	age of cat. cute!

/api/cat/name/age

POST

name	type	description
name	Text	name of cat. if null, homeless.
age	Int	age

POST

set name and age from route.

dog group

/api/dog/i/**rest

*

name	type	description
i	Int	no description
rest	[Text]	no description

*

Preconditions:

i is even.

twice

Preconditions:

i is odd.

succ