This lesson's interactive features are locked, please to keep using them

HTTP Methods - GET

HTTP defines a set of methods. We must choose one to use each time we make an HTTP request. The most common ones include:

GET
POST
PUT
DELETE

The GET method is used to "get" a representation of a specified resource. It doesn't take (remove) the data from the server but rather gets a representation, or copy, of the resource in its current state. A GET request is considered a safe method to call multiple times because it shouldn't alter the state of the server.

Making a GET Request Using Pyfetch

Normally, I'd recommend using the requests library for making HTTP requests in your python code. However in this course, we have been and will continue to use PyFetch. That's just because Boot.dev's code editor uses a WASM based Python distribution for the browser and there is only slight syntax differences between the two libraries.

The pyfetch() function accepts parameters that we can use to define things like:

method: The HTTP method of the request, like GET.
headers: The headers to send.
body: The body of the request. Often encoded as JSON.

Example GET request using pyfetch:

await pyfetch(
    url,
    method="GET",
    headers={
        "X-API-Key": "your-api-key",
    },
)

Assignment

We need to write a reusable function that retrieves all of the Jello users from our server.

Complete the get_users(url: str, api_key: str) -> list[User] function. It should:

Call pyfetch using the url parameter. The pyfetch call should:
1. Use the 'GET' Method
2. Add an X-API-Key header with api_key as the value
Return the resulting JSON data from the response

We've done this all before, but now you're writing it all from scratch!