cadey
/
ponyapi
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Please don't submit pull requests or patches here
71 Commits 2 Branches 1 Tag 202 KiB
HTML 54.4%
Java 21.3%
Nim 12.8%
Python 5.4%
Go 4.7%
Other 1.3%
Go to file
Christine Dodrill 882b5b1551 Add new X-API-Options header for bare replies 
Setting X-API-Options to bare will return unpacked values.

    $ curl --header "X-API-Options: bare" http://127.0.0.1:5000/last_aired
    {
        "name": "Do Princesses Dream of Magic Sheep?",
        "air_date": 1436628600,
        "season": 5,
        "episode": 13,
        "is_movie": false
    }
 		2015-09-08 15:48:06 -07:00
client Improved failure behavior and spelling corrections. 2015-08-19 17:10:53 -05:00
public/static update nim docs 2015-08-17 15:01:47 -07:00
.dockerignore Initial commit 2015-08-09 12:51:43 -07:00
.gitattributes update gitattributes 2015-08-13 21:10:34 -07:00
.gitignore fix gitignore and permissions 2015-08-18 16:40:45 -07:00
Dockerfile static -> public, use bash 2015-08-13 21:09:02 -07:00
LICENSE Initial commit 2015-08-09 12:51:43 -07:00
Makefile Serve /all 2015-08-13 19:47:00 -07:00
README.md fix closing bracket here 2015-08-28 16:15:06 -07:00
episode.nim split off episode manipulation code into its own module 2015-08-15 10:59:53 -07:00
fim.list Add Made in Manehattan 2015-08-25 20:34:18 -07:00
ponyapi.nim Add new X-API-Options header for bare replies 2015-09-08 15:48:06 -07:00
ponyapi.nimble implement remaining API calls 2015-08-13 20:51:03 -07:00
requirements.txt Initial commit 2015-08-09 12:51:43 -07:00
stats.nim Collect and report statistics about usage of the api server 2015-08-27 20:32:07 -07:00

README.md

PonyAPI

A simple API for episodes of My Little Pony: Friendship is Magic to be run inside a container.

API Usage

An episode will have the following data type:

{
      "air_date": 1286735400,
      "episode": 1,
      "is_movie": false,
      "name": "Friendship is Magic Part 1",
      "season": 1
}

This represents Season 1, Episode 1 of My Little Pony: Friendship Is Magic. The air_date column represents the date and time that the episode was originally shown on The Hub (now Discovery Family Network). If is_movie is set and the season number is 99, the episode record should be treated as a movie.

Usage Limits

None. Don't make the server it's running on crash and we'll all be good.

Clients

Routes

The canonical route base for PonyAPI is http://ponyapi.apps.xeserv.us. Example usage:

$ curl http://ponyapi.apps.xeserv.us/season/1/episode/1
{
  "episode": {
    "air_date": 1286735400,
    "episode": 1,
    "is_movie": false,
    "name": "Friendship is Magic Part 1",
    "season": 1
  }
}

/all

Returns all information about all episodes. This returns an array of Episode objects as defined above.

/newest

Returns the episode of My Little Pony: Friendship is Magic that will air next.

/last_aired

Returns the episode of My Little Pony: Friendship is Magic that most recently aired.

/season/<number>

Returns all information about episodes in the given season number or a 404 reply if no episodes could be found. To get all information about the movies shown, set the season as 99.

/season/<number>/episode/<number>

Returns all information about the episode with the given season and episode number. If the episode cannot be found, this will return a 404.

/random

Returns a random episode record from the list of episodes.

/search

This must be given a query paramater q containing the text to search for. Not including this will return a 406 reply. This will search the list of episode records for any episodes whose names match the given search terms. This is case-insensitive. If no episodes can be found, this will return a 404 reply.