REST-style APIs expose resources through HTTP methods and status codes. Validate both the HTTP response and the JSON structure; a 200 status does not ensure fields are present.
What You Will Learn
This lesson focuses on REST APIs: Working with JSON Over HTTP. You will connect the operation to a concrete input, inspect the result and identify the situation in which a different approach would be safer or clearer.
Network programs cross process and machine boundaries. Connections may fail, responses can be delayed, and data received from another system must be treated as untrusted until checked.
How It Works
Separate endpoint selection, transport, protocol parsing and application validation. A successful connection does not mean the remote application returned complete or correct data.
Worked Example
The following example isolates the main behavior so you can run it from a local Python installation. Read the inputs first, then follow the operation and the final printed result.
import json
body = b'{"items":[{"id":1,"name":"Pen"}]}'
parsed = json.loads(body)
if not isinstance(parsed.get("items"), list):
raise ValueError("items must be a list")
print(parsed["items"][0]["name"])Understanding the Example
Start with the setup and import statements; these define the objects that the operation needs. Follow each assignment or function call in order, noting which arguments are provided and whether the operation creates a new value, changes existing state or returns a result. Finally, inspect the printed value or assertion rather than assuming that the operation worked.
The important behavior demonstrated here is: REST-style APIs expose resources through HTTP methods and status codes. Validate both the HTTP response and the JSON structure; a 200 status does not ensure fields are present. The example uses deliberately small values so the intermediate result is easy to reason about. A larger application must still handle validation, errors and resource cleanup.
Environment note: this example may require a separately installed package, local service, platform permission or network connection. Set up the indicated environment before running it; it has not been executed automatically for this guide.
When to Use This Approach
Begin with localhost and small, deterministic examples. Add external services only when the program has timeout, retry, credential and observability requirements.
Important Behavior and Edge Cases
Indexing an unvalidated response field and failing with KeyError after an API changes.
Set timeouts, limit input sizes and validate permitted destinations before accessing user-controlled URLs. Handle socket and HTTP errors specifically, and close connections reliably.
Practice Exercise
Model a 404 response and a valid empty items list.
Before running your modified code, predict the output or expected failure. Confirm the result using at least one ordinary case and one invalid, missing or boundary input. If the operation accesses external resources, first exercise it against a controlled local or test environment.
Common Beginner Mistakes
- Indexing an unvalidated response field and failing with KeyError after an API changes.
- Set timeouts, limit input sizes and validate permitted destinations before accessing user-controlled URLs. Handle socket and HTTP errors specifically, and close connections reliably.
Key Takeaways
- REST-style APIs expose resources through HTTP methods and status codes. Validate both the HTTP response and the JSON structure; a 200 status does not ensure fields are present.
- Choose this technique for the problem it solves, but validate inputs and follow the cleanup and failure behavior shown above.
- Next practice step: Model a 404 response and a valid empty items list.