Skip to content

Grouping.md

Latest commit

 

History

History
79 lines (51 loc) · 2.48 KB

Grouping.md

File metadata and controls

79 lines (51 loc) · 2.48 KB

test v0.13.0

RESTful web API Documentation Generator

Header .md File

This is the content of the header.md file.

Table of contents

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

Grouping

Grouping

Back to top

Title and Grouping of param, success and error

GET /test/:id

Parameters - Parameter

Name Type Description
param1 String

No Group, automatically set Group to "Parameter"

Parameters - Replace "login" with this text.

Name Type Description
param2 String

Group "login"
param3 String

Group "login" with default Value

Default value: Default Value

Success response

Success response - 201 - Everything ok, replace "201" with this text.

Name Type Description
success2 String

Group "201"
success3 String

Group "201" with default Value

Default value: Default Value

Success response - Success 200

Name Type Description
success1 String

No Group, automatically set "Success 200"

Error response

Error response - 400

Name Type Description
error2 String

Undefined Group "400"

Error response - 401 - Oh oh, replace "401" with this text

Name Type Description
error3 String

Group "401"

Error response - Error 4xx

Name Type Description
error1 String

No Group automatically set "Error 4xx"

Footer .md File

This is the content of the footer.md file.