Header.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

• Header
  • Header Example
  • Parameters

---

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

Header

Header Example

Back to top

Usage of @headerExample.

GET /header/example/

Header examples

An example:

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

Parameters

Back to top

Test for @apiHeader (same as @apiParam)

GET /header/:id

Headers - Header

Name	Type	Description
header1	String	Parameter with type and description.
header2	String
header3	String	Parameter with type, description and default value.
header4	String
header5		Basic Parameter with description.
header6
header7		Basic Parameter with description and default value.
header8
header9		optional Optional basic Parameter with description.
header10		optional
header11		optional Optional basic Parameter with description and default value.
header12		optional
header13	String	optional Optional Parameter with type and description.
header14	String	optional
header15	String	optional Optional Parameter with type, description and default value.
header16	String	optional

Headers - Request headers

Name	Type	Description
reqHeader1		Basic Parameter with description.
reqHeader2		Basic Parameter with description.

Footer .md File

This is the content of the footer.md file.