Created
January 14, 2017 09:13
-
-
Save geoHeil/e1b89e4d22a3dcd815243c5174da70b2 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
FORMAT: 1A | |
HOST: http://polls.apiblueprint.org/ | |
# test | |
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 | |
} | |
] | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment