joakimskoog / anapioficeandfire Goto Github PK

Write about how users can contribute to the project

Accessing any portion of the API through the urlopen function of Python 3's urllib.request library results in a 403 code being returned. This includes even the main homepage, not just calls to the API. However, access through the browser seems to work as intended, as I'm able to access JSON data directly by entering resource URLs into the navigation bar (at least, on Chrome).

We need support for using ETag headers so that clients can use If-None-Match for cache

Retrieving the books should be made async

Transform this:

{"Id":38,"Name":"Aegon I","Culture":"Valyrian","Titles":["King of All Westeros","Shield of His People","King of the Andals, the Rhoynar and the First Men","Lord of the Seven Kingdoms","Protector of the Realm","Lord of Dragonstone"],"Aliases":["Aegon the Conqueror","Aegon the Dragon","Aegon the Dragonlord"],"Born":"27 BC, at Dragonstone","Died":"37 AC, at Dragonstone","Father":59,"Mother":1070,"Spouse":2071,"Children":[57,694],"Allegiances":[],"Books":[11,9,4,6,7,1,2,3,5,8],"PovBooks":[],"PlayedBy":[""],"TvSeries":[]}

Into:

{"Id":38,"Name":"Aegon I","Culture": 1,"Titles":[1, 2, 3, 4, 5, 6],"Aliases":["Aegon the Conqueror","Aegon the Dragon","Aegon the Dragonlord"],"Born":"27 BC, at Dragonstone","Died":"37 AC, at Dragonstone","Father":59,"Mother":1070,"Spouse":2071,"Children":[57,694],"Allegiances":[],"Books":[11,9,4,6,7,1,2,3,5,8],"PovBooks":[],"PlayedBy":[""],"TvSeries":[]},

Culture:

{"Id": 1, "Value": "Valyrian"}

Title:

{"Id": 1, "Value": "King of All Westeros"},
{"Id": 2, "Value": "Shield of His People"},
{"Id": 3, "Value": "King of the Andals, the Rhoynar and the First Men"},
{"Id": 4, "Value": "Lord of the Seven Kingdoms"},
{"Id": 5, "Value": "Protector of the Realm"},
{"Id": 6, "Value": "Lord of Dragonstone"}

etc.

Retrieving entities by name seems to be a pretty sought after feature, this would also be really simple to implement. It can either be implemented via a new action or adding filter functionality to the existing actions.

There is probably some library for that. I see a possible problem if the foreign keys are "expanded" in the JSON. Maybe do the expansion only on request?

Get request to root endpoint should return all other endpoints

Retrieving Characters should be made async

We need support for gzip on all actions to save bandwidth

Versioning of controllers via accept headers

At the moment a whole seed of the database with the Feeder takes about 1 min. It would be nice if the whole seeding operation could take under 10 seconds.

Users should be allowed to suggest new data/corrections directly (via API). System could track these suggestions separately in the server DB, and the changes could be reviewed by people and saved to the dataset files in a batch.

We want some kind of rate limiting to prevent malicious consumers

Implement mapping from IHouse to House

If the schema is defined, replacing

{"Id":38,"Name":"Aegon I","Culture":"","Titles":["King of All Westeros","Shield of His People","King of the Andals, the Rhoynar and the First Men","Lord of the Seven Kingdoms","Protector of the Realm","Lord of Dragonstone"],"Aliases":["Aegon the Conqueror","Aegon the Dragon","Aegon the Dragonlord"],"Born":"27 BC, at Dragonstone","Died":"37 AC, at Dragonstone","Father":59,"Mother":1070,"Spouse":2071,"Children":[57,694],"Allegiances":[],"Books":[11,9,4,6,7,1,2,3,5,8],"PovBooks":[],"PlayedBy":[""],"TvSeries":[]}

with

{"Id":38,"Name":"Aegon I","Titles":["King of All Westeros","Shield of His People","King of the Andals, the Rhoynar and the First Men","Lord of the Seven Kingdoms","Protector of the Realm","Lord of Dragonstone"],"Aliases":["Aegon the Conqueror","Aegon the Dragon","Aegon the Dragonlord"],"Born":"27 BC, at Dragonstone","Died":"37 AC, at Dragonstone","Father":59,"Mother":1070,"Spouse":2071,"Children":[57,694],"Books":[11,9,4,6,7,1,2,3,5,8]}

will save significant space.

Retrieving Houses should be made async

Some fields with array values are empy but in the response they have emtpy string values in them. These should be empty arrays

A guy has created a node wrapper, it should be added to the website.

https://www.reddit.com/r/asoiaf/comments/45lt0o/spoilers_everything_introducing_an_api_of_ice_and/czyxbve
https://github.com/alexwebb2/node-api-iceandfire

I don't really think that the api should reference a link to itself, because

1. Any code that could reasonably parse the information from the url, would know how to make a request for a given ID anyway.
2. The information isn't useful in and of itself

eg.

"allegiances": [  
            "http://anapioficeandfire.com/api/houses/362"
    ],

I know you probably didn't include the entire "house" object in the allegiance array because it would really bloat up the size of the request, however, if you instead used a "house summary" object, it could contain useful information, and still not be too bloated.

eg.

    "allegiances": [  
    {"ID":362,
      "name":"House Stark of Winterfell",
       "region":"The North"}
    ],

This way, some useful information can be displayed from a single API call, but the ID is still included so that additional API calls can be made for more information

According to https://www.reddit.com/r/asoiaf/comments/45lt0o/spoilers_everything_introducing_an_api_of_ice_and/czyoa78 Shireen Baratheon is missing her father and mother

We might want to implement pagination for links in resources to prevent a too big payload. A good example is Book.Characters which can have several hundreds (or even thousands) links to different Character resources.

Decide a style and implement it

The data schema is going to change rapidly (initially at least), so to make the life of client developers easier, they should be able to rely on at least one stable API version.

Might be good to include Last-Modified in response header so that clients can use If-Modified-Since for cache

Unhandled exceptions should not show stack trace to consumers. Instead show a 500 error with a message that we're working on fixing the problem.

Implement mapping from ICharacter to Character

Support for pagination in Link header