API Resource Example

Endpoint:   

/myResource
This is my resource.
post

post  /myResource

Create a resource. More text is only rendered in the details view of the method.

Request

Headers

Name
Type
Constraints
Description
Example
Authorization
string

A description.

Note that you can also add <private> blocks in here.

Body

Example

{ "name" : "myResource" }

Response

Summary

Status Code
Description
201

HTTP status code 201

Body

Example

{ "id" : 1, "name" : "myResource" }

/myResource/{myResourceId}
getdelete

get  /myResource/{myResourceId}

Retrieve a resource.

Request

URI Parameters

Name
Type
Constraints
Description
Example
myResourceId
string

Response

Summary

Status Code
Description
200
404

The resource was not found.

HTTP status code 200

Body

Example

{ "id" : 1, "name" : "myResource" }

delete  /myResource/{myResourceId}

Delete a resource.

Request

URI Parameters

Name
Type
Constraints
Description
Example
myResourceId
string

/adminResource
This is a private resource.
get

get  /adminResource

Get secret message.

Request

Response

Summary

Status Code
Description
200

HTTP status code 200

Body

Example

{"secret" : "message"}
OverviewResources/myResource/adminResource

apidoc-seed - An API documentation project using Grunt, Metalsmith and RAML.

Version: 0.0.1 | Built April 24, 2015 2:01 PM