Existing solution: SWAPI

Existing solution: SWAPI

1. UI Components

   • Input Controls
     • Specific syntax
       • people/1/
       • planets/3/
       • Specific result page
         • https://swapi.dev/api/
         • Data can be exported in multiple formats
     • Request button
     • Query (search) bar
   • Navigational Components
     • Menu button
     • Internal links to differnt parts of the SWAPI website
   • Informational Components
     • Documentation tutorial
     • Messages as guides throughout the website
     • Information paragraphs on codes, databases and developers etc.
     • Output/ result box

2. API Documentation

   • Definition: collection of reference tutorials and examples that help developers use the API
     • Best API Documentations have answers to developer question about syntax and functionality
   • SWAPI has an entire tutorial system teaching third party developers (users) to use the API and update SWAPI database
     • Reference and functionality
       • Encodings (JSON, Wookiee)
         • Attributes: films, people, planet etc. strings
         • Endpoints
           • /people/ /people/:id/ /people/schema/
         • Search Fields: name, model etc.
       • Basics
         • JSON syntax
         • No authentication needed
         • Base URL
     • Guides and tutorials
       • Gives examples of how to combine segments to generate a functional request for certain data
         • Eg. https://swapi.dev/api/people/1/
           • Examples and use cases
             • Used to find a specific person in Star Wars by number
               • Result: HTTP/1.0 200 OK Content-Type: application/json { "birth_year": "19 BBY", "eye_color": "Blue"...}

3. Data Set

   • Data types
     • String
     • Integer
     • numbers
     • date
     • text
   • Data format (JSON in default)
     • Plain text
     • Comma-separated values
     • Representational state transfer
     • Key: value pair
     • Objects
     • Array
   • Data field
     • insert specific url/ query to database

4. Possible functions in proposed solution

   • Navigation around the website
   • Search for specific data in SWAPI database
   • Display SWAPI data on website
   • Allow third party developers to edit data in SWAPI database
   • Search bar, menu button
   • Link to SWAPI.dev