hapiseed-blueprint.apib

FORMAT: 1A

# Polls API

A simple example of a REST API written in node with hapi

## index root [/]

### List All Endpoints [GET]

+ Response 200 (application/json; charset=utf-8)

        {
            "links": {
                "self": "http://localhost:1337",
                "greetings": "http://localhost:1337/greetings",
                "documentation": "http://docs.hapiseed.apiary.io/"
            }
        }

## Greetings Collection [/greetings]

### List All Greetings [GET]

+ Response 200 (application/json; charset=utf-8)

        [
            {
                "language": "en",
                "greeting": "Hi there",
                "url": "http://localhost:1337/greetings/en"
            },
            {
                "language": "fr",
                "greeting": "Bonjour",
                "url": "http://localhost:1337/greetings/fr"
            }
        ]

### create a greeting [POST]

+ Request (application/json; charset=utf-8)

        {
            "language": "us",
            "greeting": "Howdy there!"
        }

+ Response 202 (application/json; charset=utf-8)

        {
            "language": "us",
            "greeting": "Howdy there!",
            "url": "http://localhost:1337/greetings/us"
        }

## View Single Greeting [/greetings/{language}]

### View Single Greeting [GET]

+ Parameters
    + language: us (required)
+ Response 200 (application/json; charset=utf-8) 
 
        {
            "language": "us",
            "greeting": "Howdy there!",
            "url": "http://localhost:1337/greetings/us"
        }

### Greeting not found [GET]

+ Parameters
    + language: foobar (required)
+ Response 404 (application/json; charset=utf-8)  

        {
            "links": {
                "documentation":"http://docs.hapiseed.apiary.io/"
            },
            "errors": [{
                "status": "404",
                "title":  "Resource not found"
            }]
        }     
                
## Route Not Found [/foobar]

### Get Request [GET]

+ Response 404 (application/json; charset=utf-8)

        {
            "links": {
                "documentation":"http://docs.hapiseed.apiary.io/"
            },
            "errors": [{
                "status": "404",
                "title":  "Resource not found"
            }]
        }