REST_API_template.adoc

Method Title

Table of Contents

• Description
• Input Parameters
• Request Body
  • Parameters of the objectName Object (For the embedded objects)
• Successful Response
• Sample Call
  • Request Example
  • Response Example

Description

Additional information about your API call.

• URL

  _The URL Structure (path only, no root url)_

• Method:

  GET | POST | DELETE | PUT

Input Parameters

If URL params exist, specify them. Separate into optional and required. All required params should be marked with asterisk. Add data constraints, if any.

Note: All fields marked with asterisk are mandatory.

Parameter	Type	Description
Title*	Type Available values: String Object Integer An array of strings/objects	Description
Title	Type Available values: String Object Integer An array of strings/objects	Description

If there is not any parameter, add a message - This method does not have any parameters.

Request Body

• Format: JSON | XML | smth else

• Request body attributes:

Note: All fields marked with asterisk are mandatory.

Parameter	Type	Description
Title*	Type Available values: String Object Integer An array of strings/objects	Description

Parameters of the objectName Object (For the embedded objects)

Add description, if required.

Parameter	Type	Description
Title	Type Available values: String Object Integer An array of strings/objects	Description

Successful Response

• Code: 200

• Format: JSON | XML

Successful response body parameters:

Parameter	Type	Description
Title	Type Available values: String Object Integer An array of strings/objects	Description

Sample Call

Request Example

Code block

Response Example

Code block