Basic Information

Endpoint

http://example.com/{version}
version
string, one of [1], required

Welcome

Welcome to the Example Documentation. The Example API allows you to do stuff. See also example.com.

Chapter two

More content here. Including bold text!

Resources

/helloworld

This is the top level description for /helloworld.

/helloworld
GET /helloworld

Response
Body
Examples
  • Example 
    {
  "message": "Hello world"
}

/helloworld/test
GET /helloworld/test

a sub resource

/helloworld/{id}
GET /helloworld/{id}

Request
Path Variables
id
string, minimum length: 1, maximum length: 10, required

account identifier
Request Headers
Authorization
string, required

Basic authentication header

/helloworld/{id}
PUT /helloworld/{id}

Request
Path Variables
id
string, minimum length: 1, maximum length: 10, required

account identifier
Body
Properties (object)
name
string, required

name on account
gender
string, one of [male, female], required

Type Reference