Param.md

test v0.13.0

RESTful web API Documentation Generator

Header .md File

This is the content of the header.md file.

Table of contents

• Param
  • Errors
  • Param Example
  • Parameters
  • Success

---

this quote is prepended to this doc using a file prepend.md

Param

Errors

Back to top

Returned error parameters. Syntax is the same as for @apiParam

GET /param/:id

Error response

Error response - Error 4xx

Name	Type	Description
error1Error		This is Error 1.
error2Error		This is Error 2.

Param Example

Back to top

Usage of @apiParamExample.

GET /param/example/

Parameters - Parameter

Name	Type	Description
name	String	Fullname.

Examples

A common example:

curl -i http://localhost/param/example/

Parameters examples

json - A JSON example:

{
  "name": "John Doe"
}

Parameters

Back to top

Parameters and different Versions: 0.1.1

GET /param/:id

Parameters - Parameter

Name	Type	Description
param1		Parameter and description.
param2
param3		Parameter, default value and description. Default value: Default Value
param4		Default value: Default Value
param5		optional Optional parameter and description.
param6		optional
param7		optional Optional parameter, default value and description. Default value: Default Value
param8		optional Default value: Default Value
param9	String	Type, parameter and description.
param10	String
param11	String	Type, parameter and default value. Default value: Default Value
param12	String	Default value: Default Value
param13	String	optional Type, optional parameter and description.
param14	String	optional
param15	String	optional Type, optional parameter, default value and description. Default value: Default Value
param26	String	optional Default value: Default Value
param17	String	Type, size, parameter and description. Size range: 4,8
param18	Number	Type, size, parameter and description. Size range: 1-3
param19	String	Type, size, parameter, default value and description. Default value: Default Value Size range: 4,8
param20	Number	Type, size, parameter, default value and description. Default value: 1 Size range: 1-3
param21	String	Type, parameter and allowed string value. Allowed values: "value 1"
param22	String	Type, parameter and allowed list of string values. Allowed values: "value 1","value 2"
param23	Number	Type, parameter and allowed value. Allowed values: 4711
param24	Number	Type, parameter and allowed list of values. Allowed values: 4711,4712
param25	String	Type, size, parameter and allowed string value. Size range: 1,10 Allowed values: "value 1"
param27	Number	Type, size, parameter and allowed value. Size range: 1-9999 Allowed values: 4711
param28	Number	Type, size, parameter and allowed list of values. Size range: 1-9999 Allowed values: 4711,4712

Success

Back to top

Returned success parameters. Syntax is the same as for @apiParam

GET /param/:id

Error response

Error response - Error 4xx

Name	Type	Description
success1		This is Success 1.
success2		This is Success 2.

Footer .md File

This is the content of the footer.md file.