Star Wars API

Star Wars API

1. Data Interface

   • Resources
     • People
       • Attributes
         • name
           • birth year
             • eye colour
               • gender
                 • hair colour
                   • height
                     • mass
                       • skin colour
                         • homeworld
     • Films
       • Attributes
         • title
           • episode id
             • opening crawl
               • director
                 • producer
                   • release date
                     • species
                       • starships
                         • vehicles
                           • planets
     • Starships
       • Attributes
         • name
           • model
             • starship class
               • manufacturer
                 • cost in credits
                   • length
                     • crew
                       • passengers
                         • max atmosphering speed
                           • hyperdrive rating
                             • MGLT
                               • cargo capacity
                                 • consumables
     • Vehicles
       • Attributes
         • name
           • model
             • vehicle class
               • manufacturer
                 • length
                   • cost in credits
                     • crew
                       • passengers
                         • max atmosphering speed
                           • cargo capacity
                             • consumables
     • Species
       • Attributes
         • name
           • classification
             • designation
               • average height
                 • average lifespan
                   • eye colours
                     • hair colours
                       • language
                         • homeworld
     • Planets
       • Attributes
         • name
           • diameter
             • rotation period
               • orbital period
                 • gravity
                   • population
                     • climate
                       • terrain
                         • surface water
                           • residents

2. Data Structures

   • How JSON is structured on swapi.tech
     • Raw JSON is the standard data format for SWAPI
     • uses {}
     • key-value pairs are separated by commas
     • key and value are separated by :
     • key is always a string
     • value can be string, number, boolean, array, object or null
     • Sample data
       • { ... "properties": { "characters": [ "https://www.swapi.tech/api/people/1/", ... ], "created": "2014-12-10T14:23:31.880000Z", "director": "George Lucas", "edited": "2014-12-12T11:24:39.858000Z", "episode_id": 4, "opening_crawl": "It is a period of civil war ...", "planets": [ "https://www.swapi.tech/api/planets/1/", ... ], "producer": "Gary Kurtz, Rick McCallum", "release_date": "1977-05-25", "species": [ "https://www.swapi.tech/api/species/1/", ... ], "starships": [ "https://www.swapi.tech/api/starships/2/", ... ], "title": "A New Hope", "url": "https://www.swapi.tech/api/films/1/", "vehicles": [ "https://www.swapi.tech/api/vehicles/4/", ... ] } }
         • Programatically transformed JSON
           • Created: 10 December 2014
           • Director: George Lucas
           • Edited: 12 December 2014
           • Episode id: 4
           • Opening crawl: It is a period of civil war.
           • Producer: Gary Kurtz, Rick McCallum
           • Release date: 25 May 1977

3. Data Specification

   • Data types (examples retrieved from W3 schools)
     • string
       • {"name": "John"}
     • number
       • {"age": 20}
     • object
       • { "employee":{"name":"John", "age":20, "city":"New York"} }
     • array
       • { "employees":["John", "Anna", "Peter"] }
     • boolean
       • {"sale":true}
     • null
       • {"lastname":null}
   • JSON constraints/limitations
     • no error handling
     • not as robust as XML
     • lacks built-in schema validation so it may be vulnerable

4. Data Exchange

   • Network Transmission - Protocol standards
     • TCP/IP
     • UDP
     • HTTP/HTTPS
     • FTP
     • VPN
   • REST API principles
     • Uniform interface
       • standard HTTP methods
         • GET
         • POST
         • PUT
         • DELETE
     • Client-server architecture
     • Statelessness
     • Cacheable
     • Layered system
   • JSON and XML
     • JSON
       • {"breakfast menu":[{"food": "Belgian waffles", "price": "5.95", "description": "Our famous Belgian Waffles with real maple syrup"}]}
       • lightweight format efficient for data exchange
     • XML
       • <breakfast_menu> <food> <name>Belgian Waffles</name> <price>$5.95</price> <description>Our famous Belgian Waffles with real maple syrup</description> </food> </breakfast_menu>
       • maintains data integrity but is more difficult to parse than JSON