API Blueprint collection example – http://apiblueprint.org

collection-api.raw.txt

# Collection API
 
# Group Coupons
Group of all coupon-related resources.
 
## Coupon [/coupons/{id}]
A resource representing one coupon.

+ Coupon Object (application/json)
        
        { "label" : "Red" }
 
### Retrieve a Coupon [GET]
+ Response 200
 
    [Coupon][]
 
### Erase a coupon [DELETE]
+ Response 204
 
## Coupons [/coupons{?limit}]
A resource representing all coupons in the system.

+ Coupon Collection Object (application/json)

        [ { "label" : "Red" }, { "label" : "Green" }, { "label" : "Blue" } ]
 
### Retrieve all Coupons [GET]
+ Response 200
 
    [Coupon Collection][]
    
### Create a Coupon [POST]
+ Request
    
    [Coupon][]
 
+ Response 201 (text/plain)
 
        Created.

collection-api.rendered.md

Collection API

Group Coupons

Group of all coupon-related resources.

Coupon [/coupons/{id}]

A resource representing one coupon.

• Coupon Object (application/json)

    { "label" : "Red" }
  

Retrieve a Coupon [GET]

• Response 200

  [Coupon][]

Erase a coupon [DELETE]

• Response 204

Coupons [/coupons{?limit}]

A resource representing all coupons in the system.

• Coupon Collection Object (application/json)

    [ { "label" : "Red" }, { "label" : "Green" }, { "label" : "Blue" } ]
  

Retrieve all Coupons [GET]

• Response 200

  [Coupon Collection][]

Create a Coupon [POST]

• Request

  [Coupon][]

• Response 201 (text/plain)

    Created.