Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 2.7 KB

APIDOC-sample.md

File metadata and controls

79 lines (58 loc) · 2.7 KB
Raw

Pony API Documentation

The Pony API provides information about the various pony citizens living in Equestria and to be able to interact with each of them individually.

Get a list of all Pony's in this service.

Request Format: pony.php?name=all

Request Type: GET

Returned Data Format: Plain Text

Description: Return a list of all of the Ponies that you can look up in this API. The resulting pony names will be

Example Request: pony.php?name=all

Example Response:

Princess Twilight Sparkle
Rainbow Dash
Pinkie Pie
Rarity
Applejack
Fluttershy
Princess Celestia
Sunset Shimmer
...

Error Handling:

  • If missing the all, it will 400 error with a helpful message: Please pass in a pony name to lookup or all to find all of the Pony names!

Lookup a Pony's Information

Request Format: pony.php?name={name}&quotes={integer}

Request Type: GET

Returned Data Format: JSON

Description: Given a valid pony name, it returns a JSON of the basic pony information. A valid pony name does not contain any spaces and capitalized via the UpperCamelCase scheme. An optional quotes parameter may be passed in with the number of quotes to return for a particular pony. The quotes parameter default to returning 10 quotes unless specified.

Example Request: pony.php?name=RainbowDash&quotes=2

Example Response:

{
    "name": "Rainbow Dash",
    "kind": "Pegasus",
    "residence": "Cloudominium over Ponyville",
    "quotes": [
        "It needs to be about twenty-percent cooler.",
        "You can't be tied for the most daring pony!"
    ]
}

Error Handling:

  • If missing the pony name, it will 400 error with a helpful message: Please pass in a pony name to lookup or all to find all of the Pony names!
  • If passed in an invalid pony name, it will 400 error with: Given name {name} is not a valid citizen of Equestria!

Talk to a Pony

Request Format: conversation.php endpoint with POST parameters of name and message

Request Type: POST

Returned Data Format: Plain Text

Description: Given a valid pony name and a message to send, the pony will reply with a plain text message response.

Example Request: conversation.php with POST parameters of name=RainbowDash and message=yay

Example Response:

LOOOUUUUUDDEEEEEEEERRRR!!!

Error Handling:

  • If missing the pony name, it will 400 error with a message: Please pass in a pony name to talk to!
  • If passed in an invalid pony name, it will 400 error with: Given name {name} is not a valid citizen of Equestria!
  • If missing the message or if the message is empty, it will 400 error with the following message: {name} is confused by your silence. Perhaps try providing a message?