04 - 01 - GET https://intro-to.api.com/knowledge

ColterLena commented 4 years ago

In this project, you will practice accessing an API. You'll see how an API request is made, and see how data is returned from an API

Objectives

Demonstrate usage of APIs
Understand how an API request is sent.
Understand the request and response for an API.

Explorer Mode

[] Choose one of the APIs from this list that does not request "AUTH" (Authorization) since an API that requires authorization is a little more difficult to use when first learning. I have also selected some sample APIs that will be good choices:

API	Documentation
Dogs	https://dog.ceo/dog-api/
Studio Ghibli https://ghibliapi.herokuapp.com/#tag/Films
Open Brewery	https://www.openbrewerydb.org/
Recipes	http://www.recipepuppy.com/about/api/
Deck of Cards!	http://deckofcardsapi.com/
Geocode	https://geocode.xyz/api
Jobs	https://jobs.github.com/api
Lyrics	https://lyricsovh.docs.apiary.io/#reference
Quotes	https://pprathameshmore.github.io/QuoteGarden/
SpaceX	https://docs.spacexdata.com/?version=latest
Jokes	https://github.com/15Dkatz/official_joke_api

[ ] After choosing your API read the documentation.
[ ] Use the Insomnia tool to make a few queries of the API.
[ ] Capture screenshots from Insomnia showing your request and the response output.
[ ] Attach those screenshots to your homework assignment.
[ ] For one response, show a screenshot with the "Header" tab displayed.
[ ] For this response, find a few headers and describe what they do. NOTE: If the header starts with X- it is a custom header and likely is documented by your API. Other headers are more standard and can be google searched.

Adventure Mode

Read the documentation on this API: https://one-list-api.herokuapp.com/

Choose your access token from your first and last name. For example jane-doe or ron-swanson.

[ ] Use Insomnia to insert 6 items in the list associated with your access token. Attach screenshots of the request and results screen.
[ ] Use Insomnia to mark 2 of these items complete. Attach screenshots of the request and result screen.
[ ] Use Insomnia to delete 1 of the non-complete items. Attach screenshots of the request and result screen.

Epic Mode

[ ] Investigate using C#'s HttpClient class to make requests to any of the APIs you used in Adventure mode.
[ ] Create a console app that makes requests and prints the results. Submit the URL to the Github repository of this console app.

ColterLena commented 4 years ago

Hi Gavin,

Below are 4 screenshot I took for Explorer Mode of this assignment.

Here are definitions of 3 headers from "Header List for Get Brewery with ID Number 281":

Content-type Header: This header tells the client the media type for the content that it is receiving from the API.

Etag Header: This header helps the client identify specific iterations of the requested content. This feature helps the client save time and bandwidth by showing it if the content has been changed.

Strict-transport-security: This header tells web browsers that the content can only be retrieved using HTTPS as opposed to HTTP.

Best Wishes,

Colter

Get All Breweries