/ice_fire_api

Node backend for FE-3 Final

Primary LanguageJavaScript

Installation

  • Run npm install to install package dependencies
  • run npm start to start the server.
  • the server should be running on localhost:3001

Endpoints

GET: /api/v1/houses

  • This endpoint will provide json data related to GOT Houses.
  • You can expect to receive an array of JSON objects.
[
  {  
     url:"https://www.anapioficeandfire.com/api/houses/81",
     name:"House Corbray of Heart's Home",
     region:"",
     coatOfArms:"Three black ravens in flight, holding three red hearts, on a white field(Argent, three ravens volant sable, each clutching in their claws a heart gules)",
     words:"",
     titles:[  
        "Lord of Heart's Home",
        "King of the Fingers (historical)"
     ],
     seats:[  
        "Heart's Home"
     ],
     currentLord:"https://www.anapioficeandfire.com/api/characters/681",
     heir:"https://www.anapioficeandfire.com/api/characters/677",
     overlord:"https://www.anapioficeandfire.com/api/houses/7",
     founded:"",
     founder:"https://www.anapioficeandfire.com/api/characters/256",
     diedOut:"",
     ancestralWeapons:[  
        "Lady Forlorn"
     ],
     cadetBranches:[  

     ],
     swornMembers:[  
        "https://www.anapioficeandfire.com/api/characters/255",
        "https://www.anapioficeandfire.com/api/characters/256",
        "https://www.anapioficeandfire.com/api/characters/447",
        "https://www.anapioficeandfire.com/api/characters/654",
        "https://www.anapioficeandfire.com/api/characters/677",
        "https://www.anapioficeandfire.com/api/characters/681",
        "https://www.anapioficeandfire.com/api/characters/871",
        "https://www.anapioficeandfire.com/api/characters/1182"
     ]
  }
]

GET: /api/v1/character/:id

  • This endpoint expects an param to be passed in the url, the id is that of a single character
  • You can expect receive a single JSON object.
{  
   "url":"https://www.anapioficeandfire.com/api/characters/255",
   "name":"Corwyn Corbray",
   "gender":"Male",
   "culture":"",
   "born":"",
   "died":"In 134 AC, at Runestone",
   "titles":[  
      "Ser",
      "Lord Regent"
   ],
   "aliases":[  
      ""
   ],
   "father":"",
   "mother":"",
   "spouse":"https://www.anapioficeandfire.com/api/characters/871",
   "allegiances":[  
      "https://www.anapioficeandfire.com/api/houses/81"
   ],
   "books":[  
      "https://www.anapioficeandfire.com/api/books/11"
   ],
   "povBooks":[  

   ],
   "tvSeries":[  
      ""
   ],
   "playedBy":[  
      ""
   ]
}