Part 2: IA3

Part 2: IA3

1. Calling the API

   • Authentication
     • There is no authentication required for the icanhazdadjoke API.
   • API response format
     • text/html
       • HTML response (default response format).
     • application/json
       • JSON response
     • text/plain
       • Plain text response
   • Custom User Agent
     • User Agent
       • Definition: Is a request that allows a characteristic string to enable network protocol peers to identify the operating system and browser of the web-server.
       • Includes;
         • Name of the library.
         • URL/e-email
           • Allows someone to be contacted through the library/website.
             • e.g: curl -H "User-Agent: My Library (https://github.com/username/repo)" https://icanhazdadjoke.com/

2. Endpoints

   • Fetch a random dad joke
     • Connect to the database
       • Database sends joke
         • Server receives joke
           • Display programmatically transformed joke
   • Fetch a dad joke
     • Connect to the database
       • Database sends random joke from list to server
         • Server receives random joke
           • Display programmatically transformed joke
   • Fetch a dad joke as a slack message.
     • Can be used by third parties who need to receive a random joke formatted as a slack message.
       • Only returns JSON
   • Fetch a dad joke as an image.
     • Server connects to the database
       • Database sends joke to server
         • Transform joke from text to image
           • Display joke image
   • Search for dad jokes.
     • User searches for joke
     • Displays page results (e.g: 1-20)
     • Number of results to return per page is limited (e.g: 20 results per page).
     • Term: Search term to use (Default: list all jokes).