Skip to content

Commit

Permalink
Transferring API Description file from Apiary.io
Browse files Browse the repository at this point in the history
  • Loading branch information
huacnlee committed Apr 30, 2016
1 parent d425210 commit b526689
Showing 1 changed file with 80 additions and 0 deletions.
80 changes: 80 additions & 0 deletions apiary.apib
@@ -0,0 +1,80 @@
FORMAT: 1A
HOST: http://polls.apiblueprint.org/

# ruby-china

Polls is a simple API allowing consumers to view polls and vote in them.

## Questions Collection [/questions]

### List All Questions [GET]

+ Response 200 (application/json)

[
{
"question": "Favourite programming language?",
"published_at": "2015-08-05T08:40:51.620Z",
"choices": [
{
"choice": "Swift",
"votes": 2048
}, {
"choice": "Python",
"votes": 1024
}, {
"choice": "Objective-C",
"votes": 512
}, {
"choice": "Ruby",
"votes": 256
}
]
}
]

### Create a New Question [POST]

You may create your own question using this action. It takes a JSON
object containing a question and a collection of answers in the
form of choices.

+ Request (application/json)

{
"question": "Favourite programming language?",
"choices": [
"Swift",
"Python",
"Objective-C",
"Ruby"
]
}

+ Response 201 (application/json)

+ Headers

Location: /questions/2

+ Body

{
"question": "Favourite programming language?",
"published_at": "2015-08-05T08:40:51.620Z",
"choices": [
{
"choice": "Swift",
"votes": 0
}, {
"choice": "Python",
"votes": 0
}, {
"choice": "Objective-C",
"votes": 0
}, {
"choice": "Ruby",
"votes": 0
}
]
}

0 comments on commit b526689

Please sign in to comment.