STAR WARS API

STAR WARS API

1. UI COMPONENTS

   • INPUT CONTROLS
     • Text-fields
       • SWAPI has a search query that requires the user to enter a specific input so that they can find information on that object
         • people/1/
           • This input allows the user to search for characters that exist within the star wars universe
           • The number is representative of the character ID
             • The character with number 1 as the ID is Anakin Skywalker
             • There are 82 characters that can be searched in the Star Wars API
         • planets/1/
           • This input allows the user to search for planets that exist within the star wars universe
             • There are 60 planets that can be searched in the Star Wars API
         • starships/1/
           • This input allows the user to search for starships that exist within the star wars universe
             • There are 36 starships that can be searched in the Star Wars API
     • Buttons
       • The website contains a search button that when clicked, it returns all the information on the object typed in the search query
   • BUTTONS
     • The website has buttons with appropriately labelled text
   • NAVIGATIONAL COMPONENTS
     • The website has tabs located in the top right of the web page
       • HOME
         • Directs the user to the home page where they search for Star Wars Data
       • ABOUT
         • Directs the user to information about the website and are shown how to use the website
           • Features Side bar to help break information into sections, allowing the user to easily navigate and find useful information
       • DOCUMENTATION
         • Directs the user to information about resources that are used in the Star Wars API. It also teaches them how to recreate the Star Wars API
   • AESTHETICS
     • Dark background
       • White and Yellow Text
     • Simple Layout

2. API DOCUMENTATION

   • RESOURCES
     • ROOT
       • PEOPLE
         • ATTRIBUTES
           • Name
           • Birth_Year
           • Height
           • Mass
           • Hair_Colour
         • Example Request
           • http https://swapi.dev/api/people/1/
       • FILMS
         • ATTRIBUTES
           • Title
           • Episode_ID
           • Release_Date
           • Director
         • Example Request
           • http https://swapi.dev/api/films/1/
       • STARSHIPS
         • ATTRIBUTES
           • Name
           • Model
           • Starship_Class
           • Length
         • Example Request
           • http https://swapi.dev/api/starships/1/
       • SPECIES
         • ATTRIBUTES
           • Name
           • Classification
           • Average_Lifespan
           • Homeworld
         • Example Request
           • http https://swapi.dev/api/species/1/
       • PLANETS
         • ATTRIBUTES
           • Climate
           • Residents
           • Diameter
           • Name
         • Example Request
           • http https://swapi.dev/api/planets/1/
       • The Root resource provides information on all available resources within the API.
       • VEHICLES
         • ATTRIBUTES
           • Name
           • Model
           • Vehicle_Class
           • Length
         • Example Request
           • http https://swapi.dev/api/vehicles/1/

3. DATA SET

   • DATA TYPES
     • PRIMITIVE DATA TYPES
       • INT
         • Integers represent numbers that have no decimals or fractional part
           • CHARACTERS
             • Height
             • Mass
           • FILMS
             • Episode_ID
           • SPECIES
             • Average_life_span
             • Average_Height
           • STARSHIPS
             • Passengers
             • Lengths
             • Cost_in_credits
             • Crew
           • VEHICLES
             • cargo_capacity
             • Crew
             • Max_atmocspheri_speed
           • PLANETS
             • Diameter
             • Gravity
             • Population
             • Orbital_Period
             • Rotational_Period
             • Surface_water
       • DATES
         • Created
         • Edited
         • Films
           • Release_Date
     • NON PRIMITIVE DATA TYPES
       • STRINGS
         • A sequence of characters, either as a literal constant or as some kind of variable
           • The entire website is a string
       • ARRAYS
         • Data structure containing number and data values (all of which are the same type)
   • DATA FORMAT
     • JSON
       • Json is the standard data format provided by SWAPI
         • Easy to read
         • Straight-forward Syntax
       • No Dependancies