Example of API documentation auto generation

source file: here

/precondition

*
/precondition

Preconditions:

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

precondition test

/api/documentation

GET
/api/documentation

this page

cat group

/api/cat

POST
GET
/api/cat

get current name and age.

/api/cat

set name and age from query parameter.

Query parameters
namenumtypedescriptionvalue
namefirstText?no description
ageoptionInt
  • age of cat.
  • cute!

/api/cat/name/age

POST
nametypedescriptionvalue
nameText
  • name of cat.
  • if null, homeless.
ageIntage
/api/cat//

set name and age from route.

dog group

/api/dog/i/**rest

*
nametypedescriptionvalue
iIntno description
rest[Text]no description
/api/dog//

Preconditions:

  • i is even.

twice

Preconditions:

  • i is odd.

succ