SWAPI.dev

SWAPI.dev

1. Resources

   • Root
     • Attributes
       • Eg; films string -- The URL root for film resources "films": "https://swapi.dev/api/films/",
       • Eg; people string -- The URL root for people resources "people": "https://swapi.dev/api/people/"
   • People
     • Endpoints
       • Eg; /people/ -- get all the people resources
       • Eg; /people/id/ -- get a specific people resource
       • Eg; /people/schema/ -- view the JSON schema for this resource
     • Attributes
       • Eg; name string -- The name of this person. "name": "Luke Skywalker"
       • Eg; skin_color string -- The skin color of this person. "skin_color": "Fair"
     • Search Fields
       • Eg; name
   • Films
     • Endpoints
       • Eg; /films/ -- get all the film resources
       • Eg; /films/:id/ -- get a specific film resource
       • Eg; /films/schema/ -- view the JSON schema for this resource
     • Attributes
       • Eg; title string -- The title of this film. "title": "A New Hope"
       • Eg; episode_id integer -- The episode number of this film. "episode_id": 4
     • Search FIelds
       • Title
   • Starships
     • Endpoints
       • Eg; /starships/ -- get all the starship resources
       • Eg; /starships/:id/ -- get a specific starship resource
       • Eg; /starships/schema/ -- view the JSON schema for this resource
     • Attributes
       • Eg; name string -- The name of this starship. "name": "Death Star"
       • model string -- The model or official name of this starship. "model": "DS-1 Orbital Battle Station"
     • Search Fields
       • Eg; name
       • Eg; model
   • Vehicles
     • Endpoints
       • Eg; /vehicles/ -- get all the vehicle resources
       • Eg; /vehicles/:id/ -- get a specific vehicle resource
       • Eg; /vehicles/schema/ -- view the JSON schema for this resource
     • Attributes
       • Eg; name string -- The name of this vehicle. "name": "Sand Crawler"
       • Eg; model string -- The model or official name of this vehicle. "model": "Digger Crawler"
     • Search Fields
       • Eg; name
       • Eg; model
   • Species
     • Endpoints
       • Eg; /species/ -- get all the species resources
       • Eg; /species/:id/ -- get a specific species resource
       • Eg; /species/schema/ -- view the JSON schema for this resource
     • Attributes
       • Eg; name string -- The name of this species. "name": "Wookie"
       • Eg; classification string -- The classification of this species. "classification": "Mammal"
     • Search Field
       • Eg; name
   • Planets
     • Endpoints
       • Eg; /planets/ -- get all the planets resources
       • Eg; /planets/:id/ -- get a specific planets resource
       • Eg; /planets/schema/ -- view the JSON schema for this resource
     • Attributes
       • Eg; name string -- The name of this planet. "name": "Tatooine"
       • Eg; diameter string -- The diameter of this planet in kilometers. "diameter": "10465"
     • Search Fields
       • Eg; name

2. Encodings

   • JSON
     • Standard data format provided by SWAPI by default
   • Wookiee
     • Identical to JSON except with wookiee translations
     • append ?format=wookiee to the urls to use the wookiee render = https://swapi.dev/api/planets/1/?format=wookiee

3. Getting Started

   • Base URL
     • Is the root URL for all of the API
     • https://swapi.dev/api/
   • Rate Limiting
     • Used to prevent malicious abuse
     • Done via IP address
     • limited to 10,000 API requests per day
   • Authentication
     • There is no authentication required to query and get data
   • JSON Schema
     • Making a request to /api/<resource>/schema will give the details of the resources
   • Searching
     • Resources support a search parameter that filters the set of resources returned
     • Allows the user to make queries like https://swapi.dev/api/people/?search=r2