Dad Joke API (icanhazdadjoke)

Dad Joke API (icanhazdadjoke)

1. Website/Source Information

   • Description
     • The icanhazdadjoke API provides a collection of dad jokes. It allows developers to fetch random jokes or search for specific jokes programmatically
   • Base URL
     • https://icanhazdadjoke.com/

2. Dad Jokes

   • Total 744 Jokes
     • Ensure all 744 jokes can be displayed on webpage
   • Some jokes contain line breaks
     • Ensure API's formatting is maintained when jokes are displayed on webpage
   • Some jokes are very long
     • Ensure webpage provides enough space for entire joke to fit within content

3. Calling the API

   • API Response Format
     • Authentication
       • No authentication is required to use the API
     • Accepted Headers
       • text/plain
         • plain text respons
       • text/html
         • HTML response (default response format)
       • application/json
         • JSON Response

4. Retrieving Dad Joke

   • Endpoints
     • Random Joke
       • GET https://icanhazdadjoke.com/
         • The API allows users to retrieve a random dad joke by pressing a button
     • Search by Term
       • GET https://icanhazdadjoke.com/search
         • The API allows users to search for keywords in a dad joke
     • Search by ID
       • GET https://icanhazdadjoke.com/j/<joke_id>
         • The API allows users to search for a joke by entering the matching ID
     • Retrieve as Image
       • GET https://icanhazdadjoke.com/j/<joke_id>.png
         • The API allows users to retrieve a joke string as image

5. Usage Examples

   • Fetching a random dad joke (Python)
     • import requests response = requests.get('https://icanhazdadjoke.com/', headers={'Accept': 'application/json'}) joke = response.json()['joke'] print(joke)
   • Searching for Jokes (Python)
     • import requests response = requests.get('https://icanhazdadjoke.com/search', headers={'Accept': 'application/json'}, params={'term': 'chicken'}) jokes = response.json()['results'] for joke in jokes: print(joke['joke'])

6. Error Handling

   • Common Status Codes
     • 200 OK: Successful request.
     • 404 Not Found: The requested resource could not be found.
     • 500 Internal Server Error: An error occurred on the server.

7. Integration Scenarios

   • Web Application: Use the API to fetch and display jokes on a webpage.
   • Mobile Application: Integrate the API to provide jokes in a mobile app.
   • CLI Tool: Create a command-line tool that fetches and displays jokes.