Example of API documentation auto generation

source file: here

/

GET

GET

root page

/precondition

*

*

Preconditions:

HTTP/1.1 only
"Accept" header requred
user defined precondition.

precondition test

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	optional	Text	name of cat
age	optional	Int	age of cat. cute!

/api/cat/:Text¹/:Int²

POST

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

POST

set name and age from route.

dog group

/api/dog/:Int¹

*

*

Preconditions:

:Int¹ is even.

twice

Preconditions:

:Int¹ is odd.

succ