API practice
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
scripts remove mock data Mar 22, 2016
styles
README.md
index.html

README.md

Giffaw

Your goal is to integrate with the Giphy API.

https://github.com/Giphy/GiphyAPI

Basic Requirements:

  • A user can see the top 25 gifs (on page load)
  • A user can search for gifs, using the input field
  • Super Bonus: A user can "load more" gifs

Your site should look something like:

desktop layout

Solution with bonus is in the solution-more branch.

	git checkout solution-more

OR just view on GitHub by selecting the branch you want from the branch dropdown.

Introduction

You're about to write a lot of AJAX-backed JavaScript using jQuery that will complete our little Gif app.

Make use of the fantastic Giphy api: http://api.giphy.com/

Check out the documentation here: https://developers.giphy.com/docs/

Thinking Like An Engineer

As we get into more complicated problems, we need to start thinking more and more like engineers. Engineers break down large problems into the smallest possible parts, and tackle each small part one at a time.

This is one of the major skills for web development!

Here's some steps to follow to help get you in this mindset:

  1. Familiarize yourself with the docs

    • Specifically, we will be using the search endpoint
      • Also note the ever-important API Key situation (You will want to create an account with Giphy and create an App)
  2. Test the API out in your browser!

  3. Clone this project. We first want to write jQuery that returns and console.log()s that same object we saw when we opened the API in our browser.

    • Look at this example of an $.ajax request:
    $.ajax({
    
    	// What kind of request
    	method: "GET",
    
    	// The URL for the request
    	url: "http://api.api.com/search",
    
    	// The data to send aka query parameters
    	data: $("form").serialize(),
    
    	// Code to run if the request succeeds;
    	// the response is passed to the function
    	success: onSuccess,
    
    	// Code to run if the request fails; the raw request and
    	// status codes are passed to the function
    	error: onError
    });
    
    function onSuccess(json) {
    	$("div").append("<h1>"+json.title+"</h1>");
    }
    
    function onError(xhr, status, errorThrown) {
    	alert("Sorry, there was a problem!");
    	console.log("Error: " + errorThrown);
    	console.log("Status: " + status);
    	console.dir(xhr);
    }
    • How would you repurpose this to GET the data you want from the URL you want.
      • What is your base API url? What are the query parameters?
      • HINT: you need to serialize() your form data.
  4. Start playing in your scripts/app.js file.

    • Your first step is to make an Ajax call fire when your page loads. Don't try to do everything at once! First try to log the data to the console. Then work on logging specific data you want. What do you need to get the gifs to actually load on the page? There is a bunch of stuff in this data object and you need to figure out what you need.
    • Once you narrowed that down, THEN you want to build functions that generate HTML Strings and append() them to the page.
    • First log those strings to the console, and make sure they look like you think they should. THEN append them into the DOM!
  5. Can you bonus? Get the input box to make a different AJAX call to the search URL.

    • Does a search box button have a default action? What do we want do with that?
    • Are we just appending more and more gifs to the dom? Do we need to clear previous gifs before loading more?
    • OMG are you making a one page app using AJAX like a boss?
  6. Can you super bonus? Add a Load More button that, when clicked, appends 25 more gifs to the bottom of the page.

    • You will need to make use of the offset query parameter. See Search Endpoint section for more information.

Additional Resources